Enum tokio_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_str(), Some("node"));
assert_eq!(jid.domain_str(), "domain");
assert_eq!(jid.resource_str(), Some("resource"));

pub fn into_inner(self) -> String

Returns the inner String of this JID.

pub fn from_parts( node: Option<&NodePart>, domain: &DomainPart, resource: Option<&ResourcePart> ) -> 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.

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

The optional node part of the JID, as a [NodePart]

pub fn node_str(&self) -> Option<&str>

The optional node part of the JID, as a stringy reference

pub fn domain(&self) -> DomainPart

The domain part of the JID, as a [DomainPart]

pub fn domain_str(&self) -> &str

The domain part of the JID, as a stringy reference

pub fn resource(&self) -> Option<ResourcePart>

The optional resource part of the JID, as a [ResourcePart]. It is guaranteed to be present when the JID is a Full variant, which you can check with Jid::is_full.

pub fn resource_str(&self) -> Option<&str>

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

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

impl StructuralPartialEq for Jid