Struct jid::FullJid

pub struct FullJid { /* private fields */ }

A struct representing a full Jabber ID, with a resource part.

A full JID is composed of 3 components, of which only the node is optional:

• the (optional) node part is the part before the (optional) @.
• the domain part is the mandatory part between the (optional) @ and before the /.
• the resource part after the /.

Unlike a BareJid, it always contains a resource, and should only be used when you are certain there is no case where a resource can be missing. Otherwise, use a Jid or BareJid.

Implementations

impl FullJid

pub fn new(s: &str) -> Result<FullJid, Error>

Constructs a full Jabber ID containing all three components. This is of the form node@domain/resource, where node part is optional. If you want a non-fallible version, use FullJid::from_parts instead.

Examples

use jid::FullJid;

let jid = FullJid::new("node@domain/resource")?;

assert_eq!(jid.node().map(|x| x.as_str()), Some("node"));
assert_eq!(jid.domain().as_str(), "domain");
assert_eq!(jid.resource().as_str(), "resource");

pub fn into_inner(self) -> String

Returns the inner String of this JID.

pub fn from_parts( node: Option<&NodeRef>, domain: &DomainRef, resource: &ResourceRef ) -> FullJid

Build a FullJid from typed parts. This method cannot fail because it uses parts that have already been parsed and stringprepped into NodePart, DomainPart, and ResourcePart. This method allocates and does not consume the typed parts.

pub fn node(&self) -> Option<&NodeRef>

The optional node part of the JID as reference.

pub fn domain(&self) -> &DomainRef

The domain part of the JID as reference

pub fn resource(&self) -> &ResourceRef

The optional resource of the Jabber ID. Since this is a full JID it is always present.

pub fn to_bare(&self) -> BareJid

Allocate a new BareJid from this full JID, discarding the resource.

pub fn into_bare(self) -> BareJid

Transforms this full JID into a BareJid, discarding the resource.

pub fn as_str(&self) -> &str

Return a reference to the canonical string representation of the JID.

Trait Implementations

impl Clone for FullJid

fn clone(&self) -> FullJid

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FullJid

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for FullJid

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<FullJid> for Jid

fn from(full_jid: FullJid) -> Jid

Converts to this type from the input type.

impl From<FullJid> for Node

fn from(jid: FullJid) -> Node

Converts to this type from the input type.

impl FromStr for FullJid

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<FullJid, Error>

Parses a string s to return a value of this type.

impl Hash for FullJid

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoAttributeValue for FullJid

fn into_attribute_value(self) -> Option<String>

Turns this into an attribute string, or None if it shouldn’t be added.

impl Ord for FullJid

fn cmp(&self, other: &FullJid) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<FullJid> for Jid

fn eq(&self, other: &FullJid) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Jid> for FullJid

fn eq(&self, other: &Jid) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for FullJid

fn eq(&self, other: &FullJid) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for FullJid

fn partial_cmp(&self, other: &FullJid) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<Jid> for FullJid

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jid: Jid) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for FullJid

impl StructuralPartialEq for FullJid