Struct Handshake

pub struct Handshake {
    pub data: Option<[u8; 20]>,
}

The main authentication mechanism for components.

Fields

data: Option<[u8; 20]>

If Some, contains the hex-encoded SHA-1 of the concatenation of the stream id and the password, and is used to authenticate against the server.

If None, it is the successful reply from the server, the stream is now fully established and both sides can now exchange stanzas.

Implementations

impl Handshake

pub fn new() -> Handshake

Creates a successful reply from a server.

pub fn from_stream_id_and_password( stream_id: String, password: &str, ) -> Handshake

Creates an authentication request from the component.

Trait Implementations

impl AsXml for Handshake

type ItemIter<'xso_proc_as_xml_iter_lifetime> = HandshakeAsXmlIterator<'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 Handshake

fn clone(&self) -> Handshake

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Handshake

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

Formats the value using the given formatter.

impl Default for Handshake

fn default() -> Handshake

Returns the “default value” for a type.

impl From<&Handshake> for Element

fn from(other: &Handshake) -> Self

Converts to this type from the input type.

impl From<Handshake> for Element

fn from(other: Handshake) -> Self

Converts to this type from the input type.

impl FromXml for Handshake

type Builder = HandshakeFromXmlBuilder

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 Handshake

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

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 Handshake