Struct serenity::utils::ContentSafeOptions

pub struct ContentSafeOptions { /* fields omitted */ }

Struct that allows to alter content_safe's behaviour.

Methods

impl ContentSafeOptions

pub fn new() -> Self

pub fn clean_role(self, b: bool) -> Self

content_safe will replace role mentions (<@&{id}>) with its name prefixed with @ (@rolename) or with @deleted-role if the identifier is invalid.

pub fn clean_user(self, b: bool) -> Self

If set to true, content_safe will replace user mentions (<@!{id}> or <@{id}>) with the user's name prefixed with @ (@username) or with @invalid-user if the identifier is invalid.

pub fn clean_channel(self, b: bool) -> Self

If set to true, content_safe will replace channel mentions (<#{id}>) with the channel's name prefixed with # (#channelname) or with #deleted-channel if the identifier is invalid.

pub fn show_discriminator(self, b: bool) -> Self

If set to true, if content_safe replaces a user mention it will add their four digit discriminator with a preceeding #, turning @username to @username#discriminator.

pub fn display_as_member_from<G: Into<GuildId>>(self, guild: G) -> Self

If set, content_safe will replace a user mention with the user's display name in passed guild.

pub fn clean_here(self, b: bool) -> Self

If set, content_safe will replace @here with a non-pinging alternative.

pub fn clean_everyone(self, b: bool) -> Self

If set, content_safe will replace @everyone with a non-pinging alternative.

Trait Implementations

impl Clone for ContentSafeOptions

fn clone(&self) -> ContentSafeOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ContentSafeOptions

fn default() -> Self

Instantiates with all options set to true.

impl Debug for ContentSafeOptions

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

Formats the value using the given formatter.