Struct xmpp_parsers::stream::Stream

pub struct Stream {
    pub from: Option<BareJid>,
    pub to: Option<BareJid>,
    pub id: Option<String>,
    pub version: Option<String>,
    pub xml_lang: Option<String>,
}

The stream opening for client-server communications.

Fields

from: Option<BareJid>

The JID of the entity opening this stream.

to: Option<BareJid>

The JID of the entity receiving this stream opening.

id: Option<String>

The id of the stream, used for authentication challenges.

version: Option<String>

The XMPP version used during this stream.

xml_lang: Option<String>

The default human language for all subsequent stanzas, which will be transmitted to other entities for better localisation.

Implementations

impl Stream

pub fn new(to: BareJid) -> Stream

Creates a simple client→server <stream:stream> element.

pub fn with_from(self, from: BareJid) -> Stream

Sets the @from attribute on this <stream:stream> element.

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

Sets the @id attribute on this <stream:stream> element.

pub fn with_lang(self, xml_lang: String) -> Stream

Sets the @xml:lang attribute on this <stream:stream> element.

pub fn is_version(&self, version: &str) -> bool

Checks whether the version matches the expected one.

Trait Implementations

impl Clone for Stream

fn clone(&self) -> Stream

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stream

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

Formats the value using the given formatter.

impl From<Stream> for Element

fn from(elem: Stream) -> Element

Converts to this type from the input type.

impl FromXml for Stream

type Builder = FromEventsViaElement<Stream>

A builder type used to construct the element.

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

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

impl IntoXml for Stream

type EventIter = IntoEventsViaElement

The iterator type.

fn into_event_iter(self) -> Result<Self::EventIter, Error>

Return an iterator which emits the contents of the struct or enum as serialisable rxml::Event items.

impl PartialEq for Stream

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

type Error = FromElementError

The type returned in the event of a conversion error.

fn try_from(elem: Element) -> Result<Stream, FromElementError>

Performs the conversion.

impl StructuralPartialEq for Stream