Struct twilight_model::http::attachment::Attachment

pub struct Attachment {
    pub description: Option<String>,
    pub file: Vec<u8>,
    pub filename: String,
    pub id: u64,
}

Attachments used in messages.

Examples

Create an attachment of a short JSON blob describing a cat with a description for screen readers:

use twilight_model::http::attachment::Attachment;

let filename = "twilight_sparkle.json".to_owned();
let file_content = br#"{
    "best_friend": "Spike",
    "cutie_mark": "sparkles",
    "name": "Twilight Sparkle"
}"#
.to_vec();
let id = 1;

let mut attachment = Attachment::from_bytes(filename, file_content, id);
attachment.description("Raw data about Twilight Sparkle".to_owned());

Fields

description: Option<String>

Description of the attachment, useful for screen readers and users requiring alt text.

file: Vec<u8>

Content of the file.

filename: String

Name of the file.

Examples may be “twilight_sparkle.png”, “cat.jpg”, or “logs.txt”.

id: u64

Unique ID of the attachment in the message.

While attachment IDs can be the same as attachments in other messages, they must be unique within the same message. Attachment IDs don’t need to be in any particular format; for example, IDs of 0, 100, the current timestamp, and so on are all valid.

Implementations

impl Attachment

pub const fn from_bytes(filename: String, file: Vec<u8>, id: u64) -> Self

Create an attachment from a filename and bytes.

Examples

Create an attachment with a grocery list named “grocerylist.txt”:

use twilight_model::http::attachment::Attachment;

let filename = "grocerylist.txt".to_owned();
let file_content = b"Apples\nGrapes\nLemonade".to_vec();
let id = 1;

let attachment = Attachment::from_bytes(filename, file_content, id);

pub fn description(&mut self, description: String)

Set the description of the attachment.

Attachment descriptions are useful for those requiring screen readers and are displayed as alt text.

Trait Implementations

impl Clone for Attachment

fn clone(&self) -> Attachment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attachment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Attachment

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Attachment

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Attachment> for Attachment

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Attachment

impl StructuralEq for Attachment

impl StructuralPartialEq for Attachment