Struct twilight_http::request::channel::message::update_message::UpdateMessage

pub struct UpdateMessage<'a> { /* fields omitted */ }

Update a message by ChannelId and MessageId.

You can pass None to any of the methods to remove the associated field. For example, if you have a message with an embed you want to remove, you can use .embed(None) to remove the embed.

Examples

Replace the content with "test update":

use twilight_http::Client;
use twilight_model::id::{ChannelId, MessageId};

let client = Client::new("my token");
client.update_message(ChannelId(1), MessageId(2))
    .content("test update".to_owned())?
    .await?;

Remove the message’s content:

client.update_message(ChannelId(1), MessageId(2))
    .content(None)?
    .await?;

Implementations

impl<'a> UpdateMessage<'a>

pub fn attachment(self, attachment: Attachment) -> Self

Specify an attachment already present in the target message to keep.

If called, all unspecified attachments will be removed from the message. If not called, all attachments will be kept.

pub fn attachments(
    self,
    attachments: impl IntoIterator<Item = Attachment>
) -> Self

Specify multiple attachments already present in the target message to keep.

If called, all unspecified attachments will be removed from the message. If not called, all attachments will be kept.

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

Set the content of the message.

Pass None if you want to remove the message content.

Note that if there is no embed then you will not be able to remove the content of the message.

The maximum length is 2000 UTF-16 characters.

Errors

Returns an UpdateMessageErrorType::ContentInvalid error type if the content length is too long.

pub fn embed(
    self,
    embed: impl Into<Option<Embed>>
) -> Result<Self, UpdateMessageError>

Set the embed of the message.

Pass None if you want to remove the message embed.

Note that if there is no content then you will not be able to remove the embed of the message.

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

Suppress the embeds in the message.

pub fn allowed_mentions(self, allowed: AllowedMentions) -> Self

Set the AllowedMentions in the message.

Trait Implementations

impl Future for UpdateMessage<'_>

type Output = Result<Message, Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.