Struct libstrophe::Stanza

pub struct Stanza { /* private fields */ }

Proxy to the 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
• Hash by hashing internal pointer
• Drop (xmpp_stanza_release)
• Clone (xmpp_stanza_copy)
• Send

Implementations

impl Stanza

pub fn new() -> Self

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() -> Self

xmpp_presence_new

pub fn new_iq(typ: Option<&str>, id: Option<&str>) -> Self

xmpp_iq_new

pub fn new_message( typ: Option<&str>, id: Option<&str>, to: Option<&str> ) -> Self

xmpp_message_new

pub fn new_error(typ: ErrorType, text: Option<&str>) -> Self

xmpp_error_new

pub fn from_str(s: impl AsRef<str>) -> Self

xmpp_stanza_new_from_string

pub unsafe fn from_owned(inner: *mut xmpp_stanza_t) -> Self

Create an owning stanza from the raw pointer

Safety

inner must be a valid pointer to a previously allocated xmpp_stanza_t and you must make sure that there are no other usages of that pointer after calling this function.

pub unsafe fn from_ref<'st>(inner: *const xmpp_stanza_t) -> StanzaRef<'st>

Create a borrowing stanza from the constant raw pointer

Safety

inner must be a valid pointer to a previously allocated xmpp_stanza_t and you must make sure that Self doesn’t outlive the stanza behind that pointer

pub unsafe fn from_ref_mut<'st>(inner: *mut xmpp_stanza_t) -> StanzaMutRef<'st>

Create a borrowing stanza from the mutable raw pointer

Safety

inner must be a valid pointer to a previously allocated mutable xmpp_stanza_t and you must make sure that Self doesn’t outlive the stanza behind that pointer

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, ToTextError>

xmpp_stanza_to_text

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

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( &mut self, name: impl AsRef<str>, value: impl AsRef<str> ) -> Result<()>

xmpp_stanza_set_attribute

pub fn get_attribute(&self, name: impl AsRef<str>) -> 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(&mut self, name: impl AsRef<str>) -> Result<()>

xmpp_stanza_del_attribute

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

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(&mut self, id: impl AsRef<str>) -> Result<()>

xmpp_stanza_set_id

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

xmpp_stanza_get_id

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

xmpp_stanza_set_ns

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

xmpp_stanza_get_ns

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

xmpp_stanza_set_type

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

xmpp_stanza_get_type

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

xmpp_stanza_set_to

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

xmpp_stanza_get_to

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

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(&mut self) -> Option<StanzaMutRef<'_>>

xmpp_stanza_get_children

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

xmpp_stanza_get_child_by_ns

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

xmpp_stanza_get_child_by_ns

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

xmpp_stanza_get_child_by_name

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

xmpp_stanza_get_child_by_name

pub fn get_child_by_name_and_ns( &self, name: impl AsRef<str>, ns: impl AsRef<str> ) -> Option<StanzaRef<'_>>

xmpp_stanza_get_child_by_name_and_ns

pub fn get_child_by_name_and_ns_mut( &mut self, name: impl AsRef<str>, ns: impl AsRef<str> ) -> Option<StanzaMutRef<'_>>

xmpp_stanza_get_child_by_name_and_ns

pub fn get_child_by_path(&self, path: &[&str]) -> Option<StanzaRef<'_>>

xmpp_stanza_get_child_by_path

Due to internal limitations (vararg call in C) this function supports a maximum of 10 elements in the path slice.

pub fn get_child_by_path_mut( &mut self, path: &[&str] ) -> Option<StanzaMutRef<'_>>

xmpp_stanza_get_child_by_path

Due to internal limitations (vararg call in C) this function supports a maximum of 10 elements in the path slice.

pub fn children(&self) -> impl Iterator<Item = StanzaRef<'_>>

pub fn children_mut(&mut self) -> impl Iterator<Item = StanzaMutRef<'_>>

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) -> Result<()>

xmpp_stanza_add_child

pub fn reply(&self) -> Self

xmpp_stanza_reply

pub fn reply_error( &self, error_type: impl AsRef<str>, condition: impl AsRef<str>, text: impl AsRef<str> ) -> Self

xmpp_stanza_reply_error

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

xmpp_message_set_body

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

xmpp_message_get_body

Trait Implementations

impl Clone for Stanza

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stanza

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

Formats the value using the given formatter.

impl Default for Stanza

fn default() -> Self

Returns the “default value” for a type.

impl Display for Stanza

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

xmpp_stanza_to_text

impl Drop for Stanza

fn drop(&mut self)

xmpp_stanza_release

impl<'st> From<Stanza> for StanzaMutRef<'st>

fn from(s: Stanza) -> Self

Converts to this type from the input type.

impl<'st> From<Stanza> for StanzaRef<'st>

fn from(s: Stanza) -> Self

Converts to this type from the input type.

impl FromStr for Stanza

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Stanza

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Stanza> for Stanza

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Stanza

impl Send for Stanza

impl StructuralEq for Stanza