Struct xmpp::BareJid

pub struct BareJid { /* private fields */ }

A struct representing a bare Jabber ID, without a resource part.

A bare JID is composed of 2 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 /.

Unlike a FullJid, it can’t contain a resource, and should only be used when you are certain there is no case where a resource can be set. Otherwise, use a Jid or FullJid.

Implementations

impl BareJid

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

Constructs a bare Jabber ID, containing two components. This is of the form node@domain, where node part is optional. If you want a non-fallible version, use BareJid::from_parts instead.

Examples

use jid::BareJid;

let jid = BareJid::new("node@domain")?;

assert_eq!(jid.node_str(), Some("node"));
assert_eq!(jid.domain_str(), "domain");

pub fn into_inner(self) -> String

Returns the inner String of this JID.

pub fn from_parts(node: Option<&NodePart>, domain: &DomainPart) -> BareJid

Build a BareJid from typed parts. This method cannot fail because it uses parts that have already been parsed and stringprepped into NodePart and DomainPart. 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 with_resource(&self, resource: &ResourcePart) -> FullJid

Constructs a BareJid from the bare JID, by specifying a ResourcePart. If you’d like to specify a stringy resource, use BareJid::with_resource_str instead.

Examples

use jid::{BareJid, ResourcePart};

let resource = ResourcePart::new("resource").unwrap();
let bare = BareJid::new("node@domain").unwrap();
let full = bare.with_resource(&resource);

assert_eq!(full.node_str(), Some("node"));
assert_eq!(full.domain_str(), "domain");
assert_eq!(full.resource_str(), "resource");

pub fn with_resource_str(&self, resource: &str) -> Result<FullJid, Error>

Constructs a FullJid from the bare JID, by specifying a stringy resource. If your resource has already been parsed into a ResourcePart, use BareJid::with_resource.

Examples

use jid::BareJid;

let bare = BareJid::new("node@domain").unwrap();
let full = bare.with_resource_str("resource").unwrap();

assert_eq!(full.node_str(), Some("node"));
assert_eq!(full.domain_str(), "domain");
assert_eq!(full.resource_str(), "resource");

Trait Implementations

impl Clone for BareJid

fn clone(&self) -> BareJid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BareJid

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

Formats the value using the given formatter.

impl Display for BareJid

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 FromStr for BareJid

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for BareJid

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 BareJid

fn into_attribute_value(self) -> Option<String>

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

impl Ord for BareJid

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

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

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

impl StructuralPartialEq for BareJid