Enum xmpp::Jid

pub enum Jid {
    Bare(BareJid),
    Full(FullJid),
}

An enum representing a Jabber ID. It can be either a FullJid or a BareJid.

Variants

Bare(BareJid)

Contains a BareJid, without a resource part

Full(FullJid)

Contains a FullJid, with a resource part

Implementations

impl Jid

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

Constructs a Jabber ID from a string. This is of the form node@domain/resource, where node and resource parts are optional. If you want a non-fallible version, use Jid::from_parts instead.

Examples

use jid::Jid;

let jid = Jid::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().map(|x| x.as_str()), Some("resource"));

pub fn into_inner(self) -> String

Returns the inner String of this JID.

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

Build a Jid 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. To avoid allocation if both node and resource are known to be None and domain is owned, you can use domain.into().

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) -> Option<&ResourceRef>

The optional resource of the Jabber ID. It is guaranteed to be present when the JID is a Full variant, which you can check with Jid::is_full.

pub fn to_bare(&self) -> BareJid

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

pub fn into_bare(self) -> BareJid

Transforms this JID into a BareJid, throwing away the resource.

pub fn is_full(&self) -> bool

Checks if the JID contains a FullJid

pub fn is_bare(&self) -> bool

Checks if the JID contains a BareJid

pub fn as_str(&self) -> &str

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

Trait Implementations

impl Clone for Jid

fn clone(&self) -> Jid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Jid

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

Formats the value using the given formatter.

impl Display for Jid

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

Formats the value using the given formatter.

impl From<BareJid> for Jid

fn from(bare_jid: BareJid) -> Jid

Converts to this type from the input type.

impl From<BindResponse> for Jid

fn from(bind: BindResponse) -> Jid

Converts to this type from the input type.

impl From<DomainPart> for Jid

fn from(other: DomainPart) -> Jid

Converts to this type from the input type.

impl From<FullJid> for Jid

fn from(full_jid: FullJid) -> Jid

Converts to this type from the input type.

impl FromStr for Jid

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for Jid

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

where __H: Hasher,

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 Jid

fn into_attribute_value(self) -> Option<String>

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

impl Ord for Jid

fn cmp(&self, other: &Jid) -> 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<BareJid> for Jid

fn eq(&self, other: &BareJid) -> 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<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 BareJid

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<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 Jid

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 PartialOrd for Jid

fn partial_cmp(&self, other: &Jid) -> 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<FullJid, <FullJid as TryFrom<Jid>>::Error>

Performs the conversion.

impl Eq for Jid

impl StructuralPartialEq for Jid