Struct xmpp::agent::FullJid

source ·

pub struct FullJid { /* private fields */ }

Expand description

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§

source §

impl FullJid

source

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");

source

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.

source

pub fn resource(&self) -> &ResourceRef

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

source

pub fn into_inner(self) -> String

Return the inner String of this full JID.

source

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

source

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

The optional node part of the JID as reference.

source

pub fn domain(&self) -> &DomainRef

The domain part of the JID as reference

source

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.

source

pub fn to_bare(&self) -> BareJid

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

source

pub fn is_full(&self) -> bool

Checks if the JID is a full JID.

source

pub fn is_bare(&self) -> bool

Checks if the JID is a bare JID.

source

pub fn as_str(&self) -> &str

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

source

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),
}