Struct xmpp_parsers::iq::Iq

pub struct Iq {
    pub from: Option<Jid>,
    pub to: Option<Jid>,
    pub id: String,
    pub payload: IqType,
}

The main structure representing the <iq/> 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: IqType

The payload content of this stanza.

Implementations

impl Iq

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.

Trait Implementations

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(iq: Iq) -> Element

Converts to this type from the input type.

impl PartialEq for Iq

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

type Error = FromElementError

The type returned in the event of a conversion error.

fn try_from(root: Element) -> Result<Iq, FromElementError>

Performs the conversion.

impl StructuralPartialEq for Iq