Struct serenity::builder::EditMessage

pub struct EditMessage { /* private fields */ }

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":

let builder = EditMessage::new().content("hello");
message.edit(ctx, builder).await?;

Discord docs

Implementations

impl EditMessage

pub fn new() -> Self

Equivalent to Self::default.

pub fn content(self, content: impl Into<String>) -> Self

Set the content of the message.

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

pub fn add_embed(self, embed: CreateEmbed) -> Self

Add an embed for the message.

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

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

Add multiple embeds for the message.

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

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

Set an embed for the message.

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

pub fn embeds(self, embeds: Vec<CreateEmbed>) -> 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(self, suppress: bool) -> Self

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

If this is sent directly after posting the message, there is a small chance Discord hasn’t yet fully parsed the contained links and generated the embeds, so this embed suppression request has no effect. To mitigate this, you can defer the embed suppression until the embeds have loaded:

use std::time::Duration;

use futures::StreamExt;

let mut msg = channel_id.say(ctx, "<link that spawns an embed>").await?;

// When the embed appears, a MessageUpdate event is sent and we suppress the embed.
// No MessageUpdate event is sent if the message contains no embeddable link or if the link
// has been posted before and is still cached in Discord's servers (in which case the
// embed appears immediately), no MessageUpdate event is sent. To not wait forever in those
// cases, a timeout of 2000ms was added.
let msg_id = msg.id;
let mut message_updates = serenity::collector::collect(&ctx.shard, move |ev| match ev {
    Event::MessageUpdate(x) if x.id == msg_id => Some(()),
    _ => None,
});
let _ = tokio::time::timeout(Duration::from_millis(2000), message_updates.next()).await;
msg.edit(&ctx, EditMessage::new().suppress_embeds(true)).await?;

pub fn allowed_mentions(self, allowed_mentions: CreateAllowedMentions) -> Self

Set the allowed mentions for the message.

pub fn components(self, components: Vec<CreateActionRow>) -> Self

Sets the components of this message.

pub fn button(self, button: CreateButton) -> Self

Adds a clickable button to this message.

Convenience method that wraps Self::components. Arranges buttons in action rows automatically.

pub fn select_menu(self, select_menu: CreateSelectMenu) -> Self

Adds an interactive select menu to this message.

Convenience method that wraps Self::components.

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

Sets the flags for the message.

pub fn attachments(self, attachments: EditAttachments) -> Self

Sets attachments, see EditAttachments for more details.

pub fn new_attachment(self, attachment: CreateAttachment) -> Self

Adds a new attachment to the message.

Resets existing attachments. See the documentation for EditAttachments for details.

pub fn keep_existing_attachment(self, id: AttachmentId) -> Self

Shorthand for EditAttachments::keep.

pub fn remove_existing_attachment(self, id: AttachmentId) -> Self

Shorthand for EditAttachments::remove.

pub fn remove_all_attachments(self) -> Self

Shorthand for calling Self::attachments with EditAttachments::new.

Trait Implementations

impl Builder for EditMessage

Available on crate feature http only.

fn execute<'life0, 'async_trait>( self, cache_http: impl 'async_trait + CacheHttp, ctx: Self::Context<'life0> ) -> Pin<Box<dyn Future<Output = Result<Self::Built>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Edits a message in the channel.

Note: Message contents must be under 2000 unicode code points, and embeds must be under 6000 code points.

Note: Requires that the current user be the author of the message. Other users can only call Self::suppress_embeds, but additionally require the Manage Messages permission to do so.

Note: If any embeds or attachments are set, they will overwrite the existing contents of the message, deleting existing embeds and attachments. Preserving them requires calling Self::keep_existing_attachment in the case of attachments. In the case of embeds, duplicate copies of the existing embeds must be sent. Luckily, CreateEmbed implements From<Embed>, so one can simply call embed.into().

Errors

Returns a ModelError::MessageTooLong if the message contents are over the above limits.

Returns Error::Http if the user lacks permission, as well as if invalid data is given.

type Context<'ctx> = (ChannelId, MessageId, Option<UserId>)

Additional data that’s only required when sending a request off to the API.

type Built = Message

impl Clone for EditMessage

fn clone(&self) -> EditMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EditMessage

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

Formats the value using the given formatter.

impl Default for EditMessage

fn default() -> EditMessage

Returns the “default value” for a type.

impl PartialEq for EditMessage

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

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 EditMessage