Struct xmpp_parsers::presence::Presence

pub struct Presence {
    pub namespace: StanzaNamespace,
    pub from: Option<Jid>,
    pub to: Option<Jid>,
    pub id: Option<String>,
    pub type_: Option<Type>,
    pub show: Option<Show>,
    pub statuses: BTreeMap<String, String>,
    pub priority: i8,
    pub payloads: Vec<Element>,
}

The main structure representing the <presence/> stanza.

Fields

namespace: StanzaNamespace

The namespace of this stanza.

from: Option<Jid>

The sender of this presence.

to: Option<Jid>

The recipient of this presence.

id: Option<String>

The identifier, unique on this stream, of this stanza.

type_: Option<Type>

The type of this presence stanza.

show: Option<Show>

The availability of the sender of this presence.

statuses: BTreeMap<String, String>

A localised list of statuses defined in this presence.

priority: i8

The sender’s resource priority, if negative it won’t receive messages that haven’t been directed to it.

payloads: Vec<Element>

A list of payloads contained in this presence.

Implementations

impl Presence

pub fn new(type_: Option<Type>) -> Presence

Create a new presence of this type.

pub fn available() -> Presence

Create a presence without a type, which means available

pub fn error() -> Presence

Builds a presence of type Error

pub fn probe() -> Presence

Builds a presence of type Probe

pub fn subscribe() -> Presence

Builds a presence of type Subscribe

pub fn subscribed() -> Presence

Builds a presence of type Subscribed

pub fn unavailable() -> Presence

Builds a presence of type Unavailable

pub fn unsubscribe() -> Presence

Builds a presence of type Unsubscribe

pub fn with_from<J: Into<Jid>>(self, from: J) -> Presence

Set the emitter of this presence, this should only be useful for servers and components, as clients can only send presences from their own resource (which is implicit).

pub fn with_to<J: Into<Jid>>(self, to: J) -> Presence

Set the recipient of this presence, this is only useful for directed presences.

pub fn with_id(self, id: String) -> Presence

Set the identifier for this presence.

pub fn with_show(self, show: Show) -> Presence

Set the availability information of this presence.

pub fn with_priority(self, priority: i8) -> Presence

Set the priority of this presence.

pub fn with_payload<P: PresencePayload>(self, payload: P) -> Presence

Set a payload inside this presence.

pub fn with_payloads(self, payloads: Vec<Element>) -> Presence

Set the payloads of this presence.

pub fn set_status<L, S>(&mut self, lang: L, status: S)

where L: Into<String>, S: Into<String>,

Set the availability information of this presence.

pub fn add_payload<P: PresencePayload>(&mut self, payload: P)

Add a payload to this presence.

Trait Implementations

impl Clone for Presence

fn clone(&self) -> Presence

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Presence

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

Formats the value using the given formatter.

impl From<Presence> for Element

fn from(other: Presence) -> Self

Converts to this type from the input type.

impl FromXml for Presence

fn from_tree(elem: Element) -> Result<Self, Error>

Convert an XML subtree into a struct or fail with an error.

fn absent() -> Option<Self>

Provide an optional default if the element is absent.

impl IntoXml for Presence

fn into_tree(self) -> Option<Element>

Destruct the value into an optional minidom::Element.

impl PartialEq for Presence

fn eq(&self, other: &Presence) -> 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<Element> for Presence

type Error = Error

The type returned in the event of a conversion error.

fn try_from(residual: Element) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Presence