Struct ruma::events::Mentions

#[non_exhaustive]
pub struct Mentions {
    pub user_ids: BTreeSet<OwnedUserId>,
    pub room: bool,
}

Describes whether the event mentions other users or the room.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_ids: BTreeSet<OwnedUserId>

The list of mentioned users.

Defaults to an empty BTreeSet.

room: bool

Whether the whole room is mentioned.

Defaults to false.

Implementations

impl Mentions

pub fn new() -> Mentions

Create a Mentions with the default values.

pub fn with_user_ids( user_ids: impl IntoIterator<Item = OwnedUserId>, ) -> Mentions

Create a Mentions for the given user IDs.

pub fn with_room_mention() -> Mentions

Create a Mentions for a room mention.

Trait Implementations

impl Clone for Mentions

fn clone(&self) -> Mentions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mentions

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

Formats the value using the given formatter.

impl Default for Mentions

fn default() -> Mentions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Mentions

fn deserialize<__D>( __deserializer: __D, ) -> Result<Mentions, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Mentions

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.