Struct AttachmentConfig

pub struct AttachmentConfig { /* private fields */ }

Configuration for sending an attachment.

Implementations

impl AttachmentConfig

pub fn new() -> Self

Create a new default AttachmentConfig without providing a thumbnail.

To provide a thumbnail use AttachmentConfig::with_thumbnail().

pub fn with_thumbnail(thumbnail: Thumbnail) -> Self

Create a new default AttachmentConfig with a thumbnail.

Arguments

• thumbnail - The thumbnail of the media. If the content_type does not support it (eg audio clips), it is ignored.

pub fn txn_id(self, txn_id: &TransactionId) -> Self

Set the transaction ID to send.

Arguments

• txn_id - A unique ID that can be attached to a MessageEvent held in its unsigned field as transaction_id. If not given, one is created for the message.

pub fn info(self, info: AttachmentInfo) -> Self

Set the media metadata to send.

Arguments

• info - The metadata of the media. If the AttachmentInfo type doesn’t match the content_type, it is ignored.

pub fn caption(self, caption: Option<String>) -> Self

Set the optional caption

Arguments

• caption - The optional caption

pub fn formatted_caption(self, formatted_caption: Option<FormattedBody>) -> Self

Set the optional formatted caption

Arguments

• formatted_caption - The optional formatted caption

pub fn mentions(self, mentions: Option<Mentions>) -> Self

Set the mentions of the message.

Arguments

• mentions - The mentions of the message

Trait Implementations

impl Debug for AttachmentConfig

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

Formats the value using the given formatter.

impl Default for AttachmentConfig

fn default() -> AttachmentConfig

Returns the “default value” for a type.