Struct libstrophe::Stanza

pub struct Stanza<'cx> { /* fields omitted */ }

Proxy to underlying xmpp_stanza_t struct.

Most of the methods in this struct mimic the methods of the underlying library. So please see libstrophe docs and sources. Only where it's not the case or there is some additional logic involved then you can see the method description.

This struct implements:

• Display (xmpp_stanza_to_text)
• Eq by comparing internal pointers
• Drop (xmpp_stanza_release)
• Clone (xmpp_stanza_copy)
• Send

Methods

impl<'cx> Stanza<'cx>

pub fn new(ctx: &'cx Context) -> Stanza<'cx>

xmpp_stanza_new

The newly created stanza is not really useful until you assign an internal type to it. To do that you must call set_text() to make it XMPP_STANZA_TEXT stanza or set_name() to make it XMPP_STANZA_TAG stanza.

pub fn new_presence(ctx: &'cx Context) -> Stanza<'cx>

xmpp_presence_new

pub fn new_iq(
    ctx: &'cx Context,
    typ: Option<&str>,
    id: Option<&str>
) -> Stanza<'cx>

xmpp_iq_new

pub fn new_message(
    ctx: &'cx Context,
    typ: Option<&str>,
    id: Option<&str>,
    to: Option<&str>
) -> Stanza<'cx>

xmpp_message_new

pub unsafe fn from_inner(inner: *mut xmpp_stanza_t) -> Stanza<'cx>

Create an owning stanza from the raw pointer, for internal use

pub unsafe fn from_inner_ref(inner: *const xmpp_stanza_t) -> StanzaRef<'cx>

Create a borrowing stanza from the constant raw pointer, for internal use

pub unsafe fn from_inner_ref_mut(inner: *mut xmpp_stanza_t) -> StanzaMutRef<'cx>

Create a borrowing stanza from the mutable raw pointer, for internal use

pub fn as_inner(&self) -> *const xmpp_stanza_t

Return internal raw pointer to stanza, for internal use

pub fn context(&self) -> ContextRef<'cx>

Return context for this Stanza

The underlying library does not provide direct access to its context so this method works this around by relying on some of the library internals. With the new version this might need rewriting.

pub fn is_text(&self) -> bool

xmpp_stanza_is_text

pub fn is_tag(&self) -> bool

xmpp_stanza_is_tag

pub fn to_text(&self) -> Result<String>

xmpp_stanza_to_text

pub fn set_name<RefStr: AsRef<str>>(&mut self, name: RefStr) -> EmptyResult

xmpp_stanza_set_name

Be aware that calling this method changes the internal type of stanza to XMPP_STANZA_TAG.

pub fn name(&self) -> Option<&str>

xmpp_stanza_get_name

pub fn attribute_count(&self) -> i32

xmpp_stanza_get_attribute_count

pub fn set_attribute<RefStr1: AsRef<str>, RefStr2: AsRef<str>>(
    &mut self,
    name: RefStr1,
    value: RefStr2
) -> EmptyResult

xmpp_stanza_set_attribute

pub fn get_attribute<RefStr: AsRef<str>>(&self, name: RefStr) -> Option<&str>

xmpp_stanza_get_attribute

pub fn attributes(&self) -> HashMap<&str, &str>

xmpp_stanza_get_attributes

This method returns data as HashMap unlike underlying function.

pub fn del_attribute<RefStr: AsRef<str>>(&mut self, name: RefStr) -> EmptyResult

xmpp_stanza_del_attribute

pub fn set_text<RefStr: AsRef<str>>(&mut self, text: RefStr) -> EmptyResult

xmpp_stanza_set_text_with_size

Be aware that calling this method changes the internal type of stanza to XMPP_STANZA_TEXT.

pub fn text(&self) -> Option<String>

xmpp_stanza_get_text

pub fn set_id<RefStr: AsRef<str>>(&mut self, id: RefStr) -> EmptyResult

xmpp_stanza_set_id

pub fn id(&self) -> Option<&str>

xmpp_stanza_get_id

pub fn set_ns<RefStr: AsRef<str>>(&mut self, ns: RefStr) -> EmptyResult

xmpp_stanza_set_ns

pub fn ns(&self) -> Option<&str>

xmpp_stanza_get_ns

pub fn set_stanza_type<RefStr: AsRef<str>>(
    &mut self,
    typ: RefStr
) -> EmptyResult

xmpp_stanza_set_type

pub fn stanza_type(&self) -> Option<&str>

xmpp_stanza_get_type

pub fn set_to<RefStr: AsRef<str>>(&mut self, to: RefStr) -> EmptyResult

xmpp_stanza_set_to

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

xmpp_stanza_get_to

pub fn set_from<RefStr: AsRef<str>>(&mut self, from: RefStr) -> EmptyResult

xmpp_stanza_set_from

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

xmpp_stanza_get_from

pub fn get_first_child(&self) -> Option<StanzaRef>

xmpp_stanza_get_children

pub fn get_first_child_mut(&self) -> Option<StanzaMutRef>

xmpp_stanza_get_children

pub fn get_child_by_ns<RefStr: AsRef<str>>(
    &self,
    ns: RefStr
) -> Option<StanzaRef>

xmpp_stanza_get_child_by_ns

pub fn get_child_by_ns_mut<RefStr: AsRef<str>>(
    &mut self,
    ns: RefStr
) -> Option<StanzaMutRef>

xmpp_stanza_get_child_by_ns

pub fn get_child_by_name<RefStr: AsRef<str>>(
    &self,
    name: RefStr
) -> Option<StanzaRef>

xmpp_stanza_get_child_by_name

pub fn get_child_by_name_mut<RefStr: AsRef<str>>(
    &mut self,
    name: RefStr
) -> Option<StanzaMutRef>

xmpp_stanza_get_child_by_name

pub fn get_next(&self) -> Option<StanzaRef>

xmpp_stanza_get_next

pub fn get_next_mut(&mut self) -> Option<StanzaMutRef>

xmpp_stanza_get_next

pub fn add_child(&mut self, child: Stanza) -> EmptyResult

xmpp_stanza_add_child

pub fn reply(&self) -> Stanza<'cx>

xmpp_stanza_reply

pub fn set_body<RefStr: AsRef<str>>(&mut self, body: RefStr) -> EmptyResult

xmpp_message_set_body

pub fn body(&self) -> Option<String>

xmpp_message_get_body

Trait Implementations

impl<'cx> Debug for Stanza<'cx>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'cx> Hash for Stanza<'cx>

fn hash<__H: Hasher>(&self, __arg_0: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'cx> Display for Stanza<'cx>

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

xmpp_stanza_to_text

impl<'cx> Clone for Stanza<'cx>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'cx> PartialEq for Stanza<'cx>

fn eq(&self, other: &Stanza) -> 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 !=.

impl<'cx> Eq for Stanza<'cx>

impl<'cx> Drop for Stanza<'cx>

fn drop(&mut self)

xmpp_stanza_release

impl<'cx> Send for Stanza<'cx>

impl<'cx> Into<StanzaRef<'cx>> for Stanza<'cx>

fn into(self) -> StanzaRef<'cx>

Performs the conversion.

impl<'cx> Into<StanzaMutRef<'cx>> for Stanza<'cx>

fn into(self) -> StanzaMutRef<'cx>

Performs the conversion.