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

pub fn into_inner(self) -> String

Returns the inner String of this JID.

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

The optional resource part of the JID, as a ResourcePart. Since this is a full JID it is always present.

pub fn resource_str(&self) -> &str

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.

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 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 PartialEq<FullJid> 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 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 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 StructuralEq for FullJid

impl StructuralPartialEq for FullJid