#[non_exhaustive]pub struct Attachment {
pub id: AttachmentId,
pub filename: String,
pub height: Option<u64>,
pub proxy_url: String,
pub size: u64,
pub url: String,
pub width: Option<u64>,
pub content_type: Option<String>,
pub ephemeral: bool,
}
Expand description
A file uploaded with a message. Not to be confused with Embed
s.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.id: AttachmentId
The unique ID given to this attachment.
filename: String
The filename of the file that was uploaded. This is equivalent to what the uploader had their file named.
height: Option<u64>
If the attachment is an image, then the height of the image is provided.
proxy_url: String
The proxy URL.
size: u64
The size of the file in bytes.
url: String
The URL of the uploaded attachment.
width: Option<u64>
If the attachment is an image, then the width of the image is provided.
content_type: Option<String>
The attachment’s media type.
ephemeral: bool
Whether this attachment is ephemeral.
Ephemeral attachments will automatically be removed after a set period of time.
Ephemeral attachments on messages are guaranteed to be available as long as the message itself exists.
Implementations
sourceimpl Attachment
impl Attachment
sourcepub fn dimensions(&self) -> Option<(u64, u64)>
Available on crate feature model
only.
pub fn dimensions(&self) -> Option<(u64, u64)>
model
only.If this attachment is an image, then a tuple of the width and height in pixels is returned.
sourcepub async fn download(&self) -> Result<Vec<u8>>
Available on crate feature model
only.
pub async fn download(&self) -> Result<Vec<u8>>
model
only.Downloads the attachment, returning back a vector of bytes.
Examples
Download all of the attachments associated with a Message
:
use std::io::Write;
use std::path::Path;
use serenity::model::prelude::*;
use serenity::prelude::*;
use tokio::fs::File;
use tokio::io::AsyncWriteExt;
struct Handler;
#[serenity::async_trait]
impl EventHandler for Handler {
async fn message(&self, context: Context, mut message: Message) {
for attachment in message.attachments {
let content = match attachment.download().await {
Ok(content) => content,
Err(why) => {
println!("Error downloading attachment: {:?}", why);
let _ =
message.channel_id.say(&context, "Error downloading attachment").await;
return;
},
};
let mut file = match File::create(&attachment.filename).await {
Ok(file) => file,
Err(why) => {
println!("Error creating file: {:?}", why);
let _ = message.channel_id.say(&context, "Error creating file").await;
return;
},
};
if let Err(why) = file.write_all(&content).await {
println!("Error writing to file: {:?}", why);
return;
}
let _ = message
.channel_id
.say(&context, &format!("Saved {:?}", attachment.filename))
.await;
}
}
async fn ready(&self, _: Context, ready: Ready) {
println!("{} is connected!", ready.user.name);
}
}
let token = std::env::var("DISCORD_TOKEN")?;
let mut client =
Client::builder(&token, GatewayIntents::default()).event_handler(Handler).await?;
client.start().await?;
Errors
Returns an Error::Io
when there is a problem reading the contents
of the HTTP response.
Returns an Error::Http
when there is a problem retrieving the
attachment.
Trait Implementations
sourceimpl Clone for Attachment
impl Clone for Attachment
sourcefn clone(&self) -> Attachment
fn clone(&self) -> Attachment
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for Attachment
impl Debug for Attachment
sourceimpl<'de> Deserialize<'de> for Attachment
impl<'de> Deserialize<'de> for Attachment
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Serialize for Attachment
impl Serialize for Attachment
Auto Trait Implementations
impl RefUnwindSafe for Attachment
impl Send for Attachment
impl Sync for Attachment
impl Unpin for Attachment
impl UnwindSafe for Attachment
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more