Struct Message

pub struct Message {
    pub from: Option<Jid>,
    pub to: Option<Jid>,
    pub id: Option<String>,
    pub type_: MessageType,
    pub bodies: BTreeMap<String, Body>,
    pub subjects: BTreeMap<String, Subject>,
    pub thread: Option<Thread>,
    pub payloads: Vec<Element>,
}

The main structure representing the <message/> stanza.

Fields

from: Option<Jid>

The JID emitting this stanza.

to: Option<Jid>

The recipient of this stanza.

id: Option<String>

The @id attribute of this stanza, which is required in order to match a request with its response.

type_: MessageType

The type of this message.

bodies: BTreeMap<String, Body>

A list of bodies, sorted per language. Use get_best_body() to access them on reception.

subjects: BTreeMap<String, Subject>

A list of subjects, sorted per language. Use get_best_subject() to access them on reception.

thread: Option<Thread>

An optional thread identifier, so that other people can reply directly to this message.

payloads: Vec<Element>

A list of the extension payloads contained in this stanza.

Implementations

impl Message

pub fn new<J: Into<Option<Jid>>>(to: J) -> Message

Creates a new <message/> stanza of type Chat for the given recipient. This is equivalent to the Message::chat method.

pub fn new_with_type<J: Into<Option<Jid>>>(type_: MessageType, to: J) -> Message

Creates a new <message/> stanza of a certain type for the given recipient.

pub fn chat<J: Into<Option<Jid>>>(to: J) -> Message

Creates a Message of type Chat

pub fn error<J: Into<Option<Jid>>>(to: J) -> Message

Creates a Message of type Error

pub fn groupchat<J: Into<Option<Jid>>>(to: J) -> Message

Creates a Message of type Groupchat

pub fn headline<J: Into<Option<Jid>>>(to: J) -> Message

Creates a Message of type Headline

pub fn normal<J: Into<Option<Jid>>>(to: J) -> Message

Creates a Message of type Normal

pub fn with_body(self, lang: String, body: String) -> Message

Appends a body in given lang to the Message

pub fn with_payload<P: MessagePayload>(self, payload: P) -> Message

Set a payload inside this message.

pub fn with_payloads(self, payloads: Vec<Element>) -> Message

Set the payloads of this message.

pub fn get_best_body( &self, preferred_langs: Vec<&str>, ) -> Option<(String, &Body)>

Returns the best matching body from a list of languages.

For instance, if a message contains both an xml:lang=‘de’, an xml:lang=‘fr’ and an English body without an xml:lang attribute, and you pass [“fr”, “en”] as your preferred languages, Some(("fr", the_second_body)) will be returned.

If no body matches, an undefined body will be returned.

pub fn get_best_subject( &self, preferred_langs: Vec<&str>, ) -> Option<(String, &Subject)>

Returns the best matching subject from a list of languages.

For instance, if a message contains both an xml:lang=‘de’, an xml:lang=‘fr’ and an English subject without an xml:lang attribute, and you pass [“fr”, “en”] as your preferred languages, Some(("fr", the_second_subject)) will be returned.

If no subject matches, an undefined subject will be returned.

pub fn extract_payload<T: TryFrom<Element, Error = FromElementError>>( &mut self, ) -> Result<Option<T>, Error>

Try to extract the given payload type from the message’s payloads.

Returns the first matching payload element as parsed struct or its parse error. If no element matches, Ok(None) is returned. If an element matches, but fails to parse, it is nonetheless removed from the message.

Elements which do not match the given type are not removed.

Trait Implementations

impl AsXml for Message

type ItemIter<'x> = AsItemsViaElement<'x>

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.

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl From<Message> for Element

fn from(message: Message) -> Element

Converts to this type from the input type.

impl FromXml for Message

type Builder = FromEventsViaElement<Message>

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 PartialEq for Message

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

type Error = FromElementError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for Message