Enum Payload

pub enum Payload {
    Configuration {
        node: NodeName,
        form: Option<DataForm>,
    },
    Delete {
        node: NodeName,
        redirect: Option<String>,
    },
    Items {
        node: NodeName,
        published: Vec<Item>,
        retracted: Vec<ItemId>,
    },
    Purge {
        node: NodeName,
    },
    Subscription {
        node: NodeName,
        expiry: Option<DateTime>,
        jid: Option<Jid>,
        subid: Option<SubscriptionId>,
        subscription: Option<Subscription>,
    },
}

Represents an event happening to a PubSub node.

Variants

Configuration

This node’s configuration changed.

Fields

node: NodeName

The node affected.

form: Option<DataForm>

The new configuration of this node.

Delete

This node has been deleted, with an optional redirect to another node.

Fields

node: NodeName

The node affected.

redirect: Option<String>

The xmpp: URI of another node replacing this one.

Items

Some items have been published or retracted on this node.

Fields

node: NodeName

The node affected.

published: Vec<Item>

The list of published items.

retracted: Vec<ItemId>

The list of retracted items.

Purge

All items of this node just got removed at once.

Fields

node: NodeName

The node affected.

Subscription

The user’s subscription to this node has changed.

Fields

node: NodeName

The node affected.

expiry: Option<DateTime>

The time at which this subscription will expire.

jid: Option<Jid>

The JID of the user affected.

subid: Option<SubscriptionId>

An identifier for this subscription.

subscription: Option<Subscription>

The state of this subscription.

Implementations

impl Payload

pub fn node_name(&self) -> &NodeName

Return the name of the node to which this event is related.

Trait Implementations

impl AsXml for Payload

type ItemIter<'xso_proc_as_xml_iter_lifetime> = PayloadAsXmlIterator<'xso_proc_as_xml_iter_lifetime>

The iterator type.

fn as_xml_iter(&self) -> Result<Self::ItemIter<'_>, Error>

Return an iterator which emits the contents of the struct or enum as serialisable Item items.

impl Clone for Payload

fn clone(&self) -> Payload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

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

Formats the value using the given formatter.

impl From<&Payload> for Element

fn from(other: &Payload) -> Self

Converts to this type from the input type.

impl From<Payload> for Element

fn from(other: Payload) -> Self

Converts to this type from the input type.

impl FromXml for Payload

type Builder = PayloadFromXmlBuilder

A builder type used to construct the element.

fn from_events( name: QName, attrs: AttrMap, ) -> Result<Self::Builder, FromEventsError>

Attempt to initiate the streamed construction of this struct from XML.

impl PartialEq for Payload

fn eq(&self, other: &Payload) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Element> for Payload

type Error = FromElementError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for Payload