Struct CreateAllowedMentions

pub struct CreateAllowedMentions { /* private fields */ }

A builder to manage the allowed mentions on a message, used by the ChannelId::send_message and ChannelId::edit_message methods.

Examples

use serenity::builder::CreateAllowedMentions as Am;

// Mention only the user 110372470472613888
m.allowed_mentions(Am::new().users(vec![110372470472613888]));

// Mention all users and the role 182894738100322304
m.allowed_mentions(Am::new().all_users(true).roles(vec![182894738100322304]));

// Mention all roles and nothing else
m.allowed_mentions(Am::new().all_roles(true));

// Mention all roles and users, but not everyone
m.allowed_mentions(Am::new().all_users(true).all_roles(true));

// Mention everyone and the users 182891574139682816, 110372470472613888
m.allowed_mentions(
    Am::new().everyone(true).users(vec![182891574139682816, 110372470472613888]),
);

// Mention everyone and the message author.
m.allowed_mentions(Am::new().everyone(true).users(vec![msg.author.id]));

Discord docs.

Implementations

impl CreateAllowedMentions

pub fn new() -> Self

Equivalent to Self::default.

pub fn all_users(self, allow: bool) -> Self

Toggles mentions for all users. Overrides Self::users if it was previously set.

pub fn all_roles(self, allow: bool) -> Self

Toggles mentions for all roles. Overrides Self::roles if it was previously set.

pub fn everyone(self, allow: bool) -> Self

Toggles @everyone and @here mentions.

pub fn users(self, users: impl IntoIterator<Item = impl Into<UserId>>) -> Self

Sets the specific users that will be allowed mentionable.

pub fn empty_users(self) -> Self

Clear the list of mentionable users.

pub fn roles(self, roles: impl IntoIterator<Item = impl Into<RoleId>>) -> Self

Sets the specific roles that will be allowed mentionable.

pub fn empty_roles(self) -> Self

Clear the list of mentionable roles.

pub fn replied_user(self, mention_user: bool) -> Self

Makes the reply mention/ping the user.

Trait Implementations

impl Clone for CreateAllowedMentions

fn clone(&self) -> CreateAllowedMentions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAllowedMentions

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

Formats the value using the given formatter.

impl Default for CreateAllowedMentions

fn default() -> CreateAllowedMentions

Returns the “default value” for a type.

impl PartialEq for CreateAllowedMentions

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateAllowedMentions