Struct twilight_model::channel::message::AllowedMentions

pub struct AllowedMentions {
    pub parse: Vec<MentionType>,
    pub replied_user: bool,
    pub roles: Vec<Id<RoleMarker>>,
    pub users: Vec<Id<UserMarker>>,
}

Allowed mentions (pings).

Filters mentions to only ping one’s specified here, regardless of the message’s content¹.

Mentions can be clicked to reveal additional context, whilst only requiring an ID to create. See Discord Docs/Message Formatting.

AllowedMentions::default disallows all pings.

---

1. Messages must still contain mentions, e.g. @everyone! ↩

Fields

parse: Vec<MentionType>

List of allowed mention types.

MentionType::Roles and MentionType::Users allows all roles and users to be mentioned; they are mutually exclusive with the roles and users fields.

replied_user: bool

For replies, whether to mention the message author.

Defaults to false.

roles: Vec<Id<RoleMarker>>

List of roles to mention.

users: Vec<Id<UserMarker>>

List of users to mention.

Trait Implementations

impl Clone for AllowedMentions

fn clone(&self) -> AllowedMentions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AllowedMentions

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

Formats the value using the given formatter.

impl Default for AllowedMentions

fn default() -> AllowedMentions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AllowedMentions

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

Deserialize this value from the given Serde deserializer.

impl Hash for AllowedMentions

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<AllowedMentions> for AllowedMentions

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

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

Serialize this value into the given Serde serializer.

impl Eq for AllowedMentions

impl StructuralEq for AllowedMentions

impl StructuralPartialEq for AllowedMentions