Struct PreviewImage

#[non_exhaustive]
pub struct PreviewImage {
    pub source: PreviewImageSource,
    pub size: Option<UInt>,
    pub width: Option<UInt>,
    pub height: Option<UInt>,
    pub mimetype: Option<String>,
}

Metadata and PreviewImageSource of an UrlPreview image.

Modelled after OpenGraph Image Properties.

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.

source: PreviewImageSource

Source information for the image.

size: Option<UInt>

The size of the image in bytes.

width: Option<UInt>

The width of the image in pixels.

height: Option<UInt>

The height of the image in pixels.

mimetype: Option<String>

The mime_type of the image.

Implementations

impl PreviewImage

pub fn plain(url: OwnedMxcUri) -> Self

Construct a PreviewImage with the given OwnedMxcUri as the source.

pub fn encrypted(file: EncryptedFile) -> Self

Construct the PreviewImage for the given EncryptedFile as the source.

Trait Implementations

impl Clone for PreviewImage

fn clone(&self) -> PreviewImage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PreviewImage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PreviewImage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PreviewImage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.