Struct PackImage

#[non_exhaustive]
pub struct PackImage {
    pub url: OwnedMxcUri,
    pub body: Option<String>,
    pub info: Option<ImageInfo>,
    pub usage: BTreeSet<PackUsage>,
}

Available on crate features events and unstable-msc2545 only.

An image object in a image pack.

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.

url: OwnedMxcUri

The MXC URI to the media file.

body: Option<String>

An optional text body for this image. Useful for the sticker body text or the emote alt text.

Defaults to the shortcode.

info: Option<ImageInfo>

The ImageInfo object used for the info block of m.sticker events.

usage: BTreeSet<PackUsage>

The usages for the image.

Implementations

impl PackImage

pub fn new(url: OwnedMxcUri) -> PackImage

Creates a new PackImage with the given MXC URI to the media file.

Trait Implementations

impl Clone for PackImage

fn clone(&self) -> PackImage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackImage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PackImage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PackImage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.