Struct serenity::builder::EditMessage

pub struct EditMessage<'a>(pub HashMap<&'static str, Value>, pub Vec<AttachmentType<'a>>);

Available on crate feature builder only.

A builder to specify the fields to edit in an existing message.

Examples

Editing the content of a Message to "hello":

message.edit(ctx, |m| m.content("hello")).await?;

Tuple Fields

0: HashMap<&'static str, Value>

1: Vec<AttachmentType<'a>>

Implementations

impl<'a> EditMessage<'a>

pub fn content<D: ToString>(&mut self, content: D) -> &mut Self

Set the content of the message.

Note: Message contents must be under 2000 unicode code points.

pub fn add_embed<F>(&mut self, f: F) -> &mut Self where
    F: FnOnce(&mut CreateEmbed) -> &mut CreateEmbed, 

Add an embed for the message.

Note: This will keep all existing embeds. Use Self::set_embed() to replace existing embeds.

pub fn add_embeds(&mut self, embeds: Vec<CreateEmbed>) -> &mut Self

Add multiple embeds for the message.

Note: This will keep all existing embeds. Use Self::set_embeds() to replace existing embeds.

pub fn embed<F>(&mut self, f: F) -> &mut Self where
    F: FnOnce(&mut CreateEmbed) -> &mut CreateEmbed, 

Set an embed for the message.

Equivalent to Self::set_embed().

Note: This will replace all existing embeds. Use Self::add_embed() to add an additional embed.

pub fn set_embed(&mut self, embed: CreateEmbed) -> &mut Self

Set an embed for the message.

Equivalent to Self::embed().

Note: This will replace all existing embeds. Use Self::add_embed() to add an additional embed.

pub fn set_embeds(&mut self, embeds: Vec<CreateEmbed>) -> &mut Self

Set multiple embeds for the message.

Note: This will replace all existing embeds. Use Self::add_embeds() to keep existing embeds.

pub fn suppress_embeds(&mut self, suppress: bool) -> &mut Self

Suppress or unsuppress embeds in the message, this includes those generated by Discord themselves.

pub fn allowed_mentions<F>(&mut self, f: F) -> &mut Self where
    F: FnOnce(&mut CreateAllowedMentions) -> &mut CreateAllowedMentions, 

Set the allowed mentions for the message.

pub fn components<F>(&mut self, f: F) -> &mut Self where
    F: FnOnce(&mut CreateComponents) -> &mut CreateComponents, 

Creates components for this message.

pub fn set_components(&mut self, components: CreateComponents) -> &mut Self

Sets the components of this message.

pub fn flags(&mut self, flags: MessageFlags) -> &mut Self

Sets the flags for the message.

pub fn attachment(
    &mut self,
    attachment: impl Into<AttachmentType<'a>>
) -> &mut Self

Add a new attachment for the message.

This can be called multiple times.

pub fn add_existing_attachment(&mut self, attachment: AttachmentId) -> &mut Self

Add an existing attachment by id.

pub fn remove_existing_attachment(
    &mut self,
    attachment: AttachmentId
) -> &mut Self

Remove an existing attachment by id.

Trait Implementations

impl<'a> Clone for EditMessage<'a>

fn clone(&self) -> EditMessage<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for EditMessage<'a>

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

Formats the value using the given formatter.

impl<'a> Default for EditMessage<'a>

fn default() -> EditMessage<'a>

Returns the “default value” for a type.