Struct jid::FullJid

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

A struct representing a full Jabber ID.

A full Jabber ID is composed of 3 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 @ but before the /.
• A resource, resource, which is the 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 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.

resource: String

The resource of the Jabber ID.

Implementations

impl FullJid

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

Constructs a full Jabber ID containing all three components.

This is of the form node@domain/resource.

Examples

use jid::FullJid;

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

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

pub fn with_node<NS>(&self, node: NS) -> FullJid 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::FullJid;

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

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

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

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

pub fn with_domain<DS>(&self, domain: DS) -> FullJid 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::FullJid;

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

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

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::FullJid;

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

assert_eq!(jid.resource, "resource".to_owned());

let new_jid = jid.with_resource("new_resource");

assert_eq!(new_jid.resource, "new_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 String

fn from(jid: &FullJid) -> String

Converts to this type from the input type.

impl From<FullJid> for BareJid

fn from(full: FullJid) -> BareJid

Converts to this type from the input type.

impl From<FullJid> for Jid

fn from(full_jid: FullJid) -> Jid

Converts to this type from the input type.

impl From<FullJid> for String

fn from(jid: FullJid) -> String

Converts to this type from the input type.

impl FromStr for FullJid

type Err = JidParseError

The associated error which can be returned from parsing.

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

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, 

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: &FullJid) -> bool

This method tests for !=.

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 !=.

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 !=.

impl TryFrom<Jid> for FullJid

type Error = JidParseError

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