Struct Item 

pub struct Item {
    pub affiliation: Option<Affiliation>,
    pub jid: Option<BareJid>,
    pub nick: Option<String>,
    pub role: Option<Role>,
    pub actor: Option<Actor>,
    pub reason: Option<Reason>,
}

An item representing a user in a room.

Fields

affiliation: Option<Affiliation>

The affiliation of this user with the room.

MUST be set when request/modifying affiliations.

jid: Option<BareJid>

The real JID of this user, if you are allowed to see it.

nick: Option<String>

The current nickname of this user.

role: Option<Role>

The current role of this user or selector for users with this role

actor: Option<Actor>

The actor affected by this item.

reason: Option<Reason>

A reason for this item.

Implementations

impl Item

pub fn new() -> Item

Creates a new item with the given affiliation and role.

pub fn with_jid(self, jid: BareJid) -> Item

Set a jid for this Item

pub fn with_nick<S: Into<String>>(self, nick: S) -> Item

Set a nick for this Item

pub fn with_actor(self, actor: Actor) -> Item

Set an actor for this Item

pub fn with_reason<S: Into<String>>(self, reason: S) -> Item

Set a reason for this Item

pub fn with_affiliation(self, affiliation: Affiliation) -> Item

Set affiliation for this Item

pub fn with_role(self, role: Role) -> Item

Set role for this Item

Trait Implementations

impl AsXml for Item

type ItemIter<'xso_proc_as_xml_iter_lifetime> = ItemAsXmlIterator<'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 Item

fn clone(&self) -> Item

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Item

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

Formats the value using the given formatter.

impl Default for Item

fn default() -> Item

Returns the “default value” for a type.

impl From<&Item> for Element

fn from(other: &Item) -> Self

Converts to this type from the input type.

impl From<Item> for Element

fn from(other: Item) -> Self

Converts to this type from the input type.

impl FromXml for Item

type Builder = ItemFromXmlBuilder

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 Item

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

impl TryFrom<Element> for Item

type Error = FromElementError

The type returned in the event of a conversion error.

fn try_from(other: Element) -> Result<Self, FromElementError>

Performs the conversion.