Skip to main content

ImagePreview

Struct ImagePreview 

Source
pub struct ImagePreview { /* private fields */ }
Expand description

Thumbnail for Image, Video, and Link messages. Also used as bot profile pictures. The source is stored lazily and resolved when resolve or try_resolve is called(either manually or automatically by message builders). Any error falls back to a default ~600 bytes in size JPEG placeholder.

Implementations§

Source§

impl ImagePreview

Source

pub fn from_bytes(bytes: impl Into<Vec<u8>>) -> Self

Thumbnail from raw JPEG bytes. Fails on resolve if the encoded data URI exceeds 13333 bytes.

Source

pub fn raw(uri: impl Into<String>) -> Self

Thumbnail from a pre-assembled `data:image/jpg;base64,{base64_contents} URI string.

Source

pub fn from_file(path: impl AsRef<Path>) -> Self

Thumbnail loaded from a file; the file is read lazily when resolved.

Source

pub fn kind(&self) -> PreviewKind

Source

pub async fn resolve(self) -> String

Like Self::try_resolve but falls back to the default placeholder preview on error.

Source

pub async fn try_resolve(self) -> Result<String, PreviewError>

Returns the preview as a data:image/jpg;base64,{base64_contents} URI. The source is assumed to be a valid JPEG(encoding is not validated) when multimedia feature is off or is lazily transcoded to JPEG when multimedia feature is on. Fails if the source cannot be read or the encoded URI exceeds 13333 bytes.

Trait Implementations§

Source§

impl Clone for ImagePreview

Source§

fn clone(&self) -> ImagePreview

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ImagePreview

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ImagePreview

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V