Enum Iq

pub enum Iq {
    Get {
        from: Option<Jid>,
        to: Option<Jid>,
        id: String,
        payload: Element,
    },
    Set {
        from: Option<Jid>,
        to: Option<Jid>,
        id: String,
        payload: Element,
    },
    Result {
        from: Option<Jid>,
        to: Option<Jid>,
        id: String,
        payload: Option<Element>,
    },
    Error {
        from: Option<Jid>,
        to: Option<Jid>,
        id: String,
        error: StanzaError,
        payload: Option<Element>,
    },
}

The main structure representing the <iq/> stanza.

Variants

Get

An <iq type='get'/> stanza.

Fields

from: Option<Jid>

The JID emitting this stanza.

to: Option<Jid>

The recipient of this stanza.

id: String

The @id attribute of this stanza, which is required in order to match a request with its result/error.

payload: Element

The payload content of this stanza.

Set

An <iq type='set'/> stanza.

Fields

from: Option<Jid>

The JID emitting this stanza.

to: Option<Jid>

The recipient of this stanza.

id: String

The @id attribute of this stanza, which is required in order to match a request with its result/error.

payload: Element

The payload content of this stanza.

Result

An <iq type='result'/> stanza.

Fields

from: Option<Jid>

The JID emitting this stanza.

to: Option<Jid>

The recipient of this stanza.

id: String

The @id attribute of this stanza, which is required in order to match a request with its result/error.

payload: Option<Element>

The payload content of this stanza.

Error

An <iq type='error'/> stanza.

Fields

from: Option<Jid>

The JID emitting this stanza.

to: Option<Jid>

The recipient of this stanza.

id: String

The @id attribute of this stanza, which is required in order to match a request with its result/error.

error: StanzaError

The error carried by this stanza.

payload: Option<Element>

The optional payload content which caused the error.

As per RFC 6120 § 8.3.1, the emitter of an error stanza MAY include the original XML which caused the error. However, recipients MUST NOT rely on this.

Implementations

impl Iq

pub fn assemble(header: IqHeader, data: IqPayload) -> Self

Assemble a new Iq stanza from an IqHeader and the given IqPayload.

pub fn from_get<S: Into<String>>(id: S, payload: impl IqGetPayload) -> Iq

Creates an <iq/> stanza containing a get request.

pub fn from_set<S: Into<String>>(id: S, payload: impl IqSetPayload) -> Iq

Creates an <iq/> stanza containing a set request.

pub fn empty_result<S: Into<String>>(to: Jid, id: S) -> Iq

Creates an empty <iq type="result"/> stanza.

pub fn from_result<S: Into<String>>( id: S, payload: Option<impl IqResultPayload>, ) -> Iq

Creates an <iq/> stanza containing a result.

pub fn from_error<S: Into<String>>(id: S, payload: StanzaError) -> Iq

Creates an <iq/> stanza containing an error.

pub fn with_to(self, to: Jid) -> Iq

Sets the recipient of this stanza.

pub fn with_from(self, from: Jid) -> Iq

Sets the emitter of this stanza.

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

Sets the id of this stanza, in order to later match its response.

pub fn from(&self) -> Option<&Jid>

Access the sender address.

pub fn from_mut(&mut self) -> &mut Option<Jid>

Access the sender address, mutably.

pub fn to(&self) -> Option<&Jid>

Access the recipient address.

pub fn to_mut(&mut self) -> &mut Option<Jid>

Access the recipient address, mutably.

pub fn id(&self) -> &str

Access the id.

pub fn id_mut(&mut self) -> &mut String

Access the id mutably.

pub fn split(self) -> (IqHeader, IqPayload)

Split the IQ stanza in its metadata and data.

Note that this discards the optional original error-inducing payload of the Iq::Error variant.

pub fn into_header(self) -> IqHeader

Return the IqHeader of this stanza, discarding the payload.

pub fn into_payload(self) -> IqPayload

Return the IqPayload of this stanza, discarding the header.

Note that this also discards the optional original error-inducing payload of the Iq::Error variant.

Trait Implementations

impl AsXml for Iq

type ItemIter<'xso_proc_as_xml_iter_lifetime> = IqAsXmlIterator<'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.

fn as_xml_dyn_iter<'x>( &'x self, ) -> Result<Box<dyn Iterator<Item = Result<Item<'x>, Error>> + 'x>, Error>

Return the same iterator as as_xml_iter, but boxed to erase the concrete iterator type.

impl Clone for Iq

fn clone(&self) -> Iq

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Iq

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

Formats the value using the given formatter.

impl From<&Iq> for Element

fn from(other: &Iq) -> Self

Converts to this type from the input type.

impl From<Iq> for Element

fn from(other: Iq) -> Self

Converts to this type from the input type.

impl FromXml for Iq

type Builder = IqFromXmlBuilder

A builder type used to construct the element.

fn from_events( name: QName, attrs: AttrMap, ctx: &Context<'_>, ) -> Result<Self::Builder, FromEventsError>

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

fn xml_name_matcher() -> XmlNameMatcher<'static>

Return a predicate which determines if Self may be parsed from a given XML element.

impl PartialEq for Iq

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

type Error = FromElementError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for Iq