Struct EditAttachments

pub struct EditAttachments { /* private fields */ }

You can add new attachments and edit existing ones using this builder.

When this builder is not supplied in a message edit, Discord keeps the attachments intact. However, as soon as a builder is supplied, Discord removes all attachments from the message. If you want to keep old attachments, you must specify this either using Self::keep_all, or individually for each attachment using Self::keep.

Examples

Removing all attachments

msg.edit(ctx, EditMessage::new().attachments(EditAttachments::new())).await?;

Adding a new attachment without deleting existing attachments

msg.edit(ctx, EditMessage::new().attachments(
    EditAttachments::keep_all(&msg).add(my_attachment)
)).await?;

Delete all but the first attachment

msg.edit(ctx, EditMessage::new().attachments(
    EditAttachments::new().keep(msg.attachments[0].id)
)).await?;

Delete only the first attachment

msg.edit(ctx, EditMessage::new().attachments(
    EditAttachments::keep_all(&msg).remove(msg.attachments[0].id)
)).await?;

Notes

Internally, this type is used not just for message editing endpoints, but also for message creation endpoints.

Implementations

impl EditAttachments

pub fn new() -> Self

An empty attachments builder.

Existing attachments are not kept by default, either. See Self::keep_all() or Self::keep().

pub fn keep_all(msg: &Message) -> Self

Creates a new attachments builder that keeps all existing attachments.

Shorthand for Self::new() and calling Self::keep() for every AttachmentId in Message::attachments.

If you only want to keep a subset of attachments from the message, either implement this method manually, or use Self::remove().

Note: this EditAttachments must be run on the same message as is supplied here, or else Discord will throw an error!

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

This method adds an existing attachment to the list of attachments that are kept after editing.

Opposite of Self::remove.

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

This method removes an existing attachment from the list of attachments that are kept after editing.

Opposite of Self::keep.

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

Adds a new attachment to the attachment list.

Trait Implementations

impl Clone for EditAttachments

fn clone(&self) -> EditAttachments

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EditAttachments

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

Formats the value using the given formatter.

impl Default for EditAttachments

fn default() -> EditAttachments

Returns the “default value” for a type.

impl PartialEq for EditAttachments

fn eq(&self, other: &EditAttachments) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for EditAttachments

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 EditAttachments