Struct xmpp::agent::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(unnormalized: &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 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 resource(&self) -> &ResourceRef

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

pub fn into_inner(self) -> String

Return the inner String of this full JID.

pub fn into_bare(self) -> BareJid

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

let jid: FullJid = "foo@bar/baz".parse().unwrap();
let bare = jid.into_bare();
assert_eq!(bare.to_string(), "foo@bar");

Methods from Deref<Target = Jid>

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 is_full(&self) -> bool

Checks if the JID is a full JID.

pub fn is_bare(&self) -> bool

Checks if the JID is a bare JID.

pub fn as_str(&self) -> &str

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

pub fn try_as_full(&self) -> Result<&FullJid, &BareJid>

Try to convert this Jid reference to a &FullJid if it contains a resource and return a &BareJid otherwise.

This is useful for match blocks:

let jid: Jid = "foo@bar".parse().unwrap();
match jid.try_as_full() {
    Ok(full) => println!("it is full: {:?}", full),
    Err(bare) => println!("it is bare: {:?}", bare),
}

Trait Implementations

impl AsXmlText for FullJid

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert jid::FullJid to XML text via Display.

This implementation never fails.

fn as_optional_xml_text(&self) -> Result<Option<Cow<'_, str>>, Error>

Convert the value to an XML string in a context where an absent value can be represented.

impl Borrow<Jid> for FullJid

fn borrow(&self) -> &Jid

Immutably borrows from an owned value.

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 Deref for FullJid

type Target = Jid

The resulting type after dereferencing.

fn deref(&self) -> &<FullJid as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for FullJid

fn deserialize<D>( deserializer: D, ) -> Result<FullJid, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FullJid

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

Formats the value using the given formatter.

impl From<BindResponse> for FullJid

fn from(bind: BindResponse) -> FullJid

Converts to this type from the input type.

impl From<FullJid> for Jid

fn from(other: FullJid) -> Jid

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, <FullJid as FromStr>::Err>

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

impl FromXmlText for FullJid

fn from_xml_text(s: String) -> Result<FullJid, Error>

Parse jid::FullJid from XML text via FromStr.

impl Hash for FullJid

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

Tests for self and other values to be equal, and is used by ==.

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for FullJid

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl ToTokens for FullJid

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self directly into a TokenStream object.

impl TryFrom<Jid> for FullJid

type Error = Error

The type returned in the event of a conversion error.

fn try_from(inner: Jid) -> Result<FullJid, <FullJid as TryFrom<Jid>>::Error>

Performs the conversion.

impl Eq for FullJid

impl StructuralPartialEq for FullJid