Struct CreateAttachment

#[non_exhaustive]
pub struct CreateAttachment {
    pub filename: String,
    pub description: Option<String>,
    pub data: Vec<u8>,
    /* private fields */
}

A builder for creating a new attachment from a file path, file data, or URL.

Discord docs.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

filename: String

description: Option<String>

data: Vec<u8>

Implementations

impl CreateAttachment

pub fn bytes( data: impl Into<Vec<u8>>, filename: impl Into<String>, ) -> CreateAttachment

Builds an CreateAttachment from the raw attachment data.

pub async fn path(path: impl AsRef<Path>) -> Result<CreateAttachment>

Builds an CreateAttachment by reading a local file.

Errors

Error::Io if reading the file fails.

pub async fn file( file: &File, filename: impl Into<String>, ) -> Result<CreateAttachment>

Builds an CreateAttachment by reading from a file handler.

Errors

Error::Io error if reading the file fails.

pub async fn url(http: impl AsRef<Http>, url: &str) -> Result<CreateAttachment>

Builds an CreateAttachment by downloading attachment data from a URL.

Errors

Error::Url if the URL is invalid, Error::Http if downloading the data fails.

pub fn to_base64(&self) -> String

Converts the stored data to the base64 representation.

This is used in the library internally because Discord expects image data as base64 in many places.

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

Sets a description for the file (max 1024 characters).

Trait Implementations

impl Clone for CreateAttachment

fn clone(&self) -> CreateAttachment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAttachment

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

Formats the value using the given formatter.

impl PartialEq for CreateAttachment

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

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 CreateAttachment