Struct jid::BareJid

pub struct BareJid {
    pub node: Option<String>,
    pub domain: String,
}

A struct representing a bare Jabber ID.

A bare Jabber ID is composed of 2 components, of which one is optional:

• A node/name, node, which is the optional part before the @.
• A domain, domain, which is the mandatory part after 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 enum.

Fields

node: Option<String>

The node part of the Jabber ID, if it exists, else None.

domain: String

The domain of the Jabber ID.

Methods

impl BareJid

pub fn new<NS, DS>(node: NS, domain: DS) -> BareJid where
    NS: Into<String>,
    DS: Into<String>, 

Constructs a bare Jabber ID, containing two components.

This is of the form node@domain.

Examples

use jid::BareJid;

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

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

pub fn domain<DS>(domain: DS) -> BareJid where
    DS: Into<String>, 

Constructs a bare Jabber ID containing only a domain.

This is of the form domain.

Examples

use jid::BareJid;

let jid = BareJid::domain("domain");

assert_eq!(jid.node, None);
assert_eq!(jid.domain, "domain".to_owned());

pub fn with_node<NS>(&self, node: NS) -> BareJid where
    NS: Into<String>, 

Constructs a new Jabber ID from an existing one, with the node swapped out with a new one.

Examples

use jid::BareJid;

let jid = BareJid::domain("domain");

assert_eq!(jid.node, None);

let new_jid = jid.with_node("node");

assert_eq!(new_jid.node, Some("node".to_owned()));

pub fn with_domain<DS>(&self, domain: DS) -> BareJid where
    DS: Into<String>, 

Constructs a new Jabber ID from an existing one, with the domain swapped out with a new one.

Examples

use jid::BareJid;

let jid = BareJid::domain("domain");

assert_eq!(jid.domain, "domain");

let new_jid = jid.with_domain("new_domain");

assert_eq!(new_jid.domain, "new_domain");

pub fn with_resource<RS>(self, resource: RS) -> FullJid where
    RS: Into<String>, 

Constructs a full Jabber ID from a bare Jabber ID, specifying a resource.

Examples

use jid::BareJid;

let bare = BareJid::new("node", "domain");
let full = bare.with_resource("resource");

assert_eq!(full.node, Some("node".to_owned()));
assert_eq!(full.domain, "domain".to_owned());
assert_eq!(full.resource, "resource".to_owned());

Trait Implementations

impl From<BareJid> for Jid

fn from(bare_jid: BareJid) -> Jid

Performs the conversion.

impl From<BareJid> for String

fn from(jid: BareJid) -> String

Performs the conversion.

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 Into<BareJid> for FullJid

fn into(self) -> BareJid

Performs the conversion.

impl Eq for BareJid

impl PartialEq<BareJid> 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: &BareJid) -> bool

This method tests for !=.

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

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, 

Feeds a slice of this type into the given [Hasher].

impl FromStr for BareJid

type Err = JidParseError

The associated error which can be returned from parsing.

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

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