Struct serenity::builder::CreateAllowedMentions

pub struct CreateAllowedMentions(pub HashMap<&'static str, Value>);

Available on crate feature builder only.

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::ParseValue;

// Mention only the user 110372470472613888
m.allowed_mentions(|am| am.empty_parse().users(vec![110372470472613888]));

// Mention all users and the role 182894738100322304
m.allowed_mentions(|am| am.parse(ParseValue::Users).roles(vec![182894738100322304]));

// Mention all roles and nothing else
m.allowed_mentions(|am| am.parse(ParseValue::Roles));

// Mention all roles and users, but not everyone
m.allowed_mentions(|am| am.parse(ParseValue::Users).parse(ParseValue::Roles));

// Mention everyone and the users 182891574139682816, 110372470472613888
m.allowed_mentions(|am| {
    am.parse(ParseValue::Everyone).users(vec![182891574139682816, 110372470472613888])
});

// Mention everyone and the message author.
m.allowed_mentions(|am| am.parse(ParseValue::Everyone).users(vec![msg.author.id]));

Tuple Fields

0: HashMap<&'static str, Value>

Implementations

impl CreateAllowedMentions

pub fn parse(&mut self, value: ParseValue) -> &mut Self

Add a value that’s allowed to be mentioned.

If users or roles is specified, Self::users and Self::roles will not work.
If you use either, do not specify it’s same type here.

pub fn empty_parse(&mut self) -> &mut Self

Clear all the values that would be mentioned.

If parse is empty, the message will not mention anyone, unless they are specified on Self::users or Self::roles.

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

Sets the users that will be allowed to be mentioned.

pub fn empty_users(&mut self) -> &mut Self

Makes users unable to be mentioned.

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

Sets the roles that will be allowed to be mentioned.

pub fn empty_roles(&mut self) -> &mut Self

Makes roles unable to be mentioned.

pub fn replied_user(&mut self, mention_user: bool) -> &mut 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.