Enum GalleryItemType

#[non_exhaustive]
pub enum GalleryItemType {
    Audio(AudioMessageEventContent),
    File(FileMessageEventContent),
    Image(ImageMessageEventContent),
    Video(VideoMessageEventContent),
}

Available on crate feature events only.

The content that is specific to each gallery item type variant.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Audio(AudioMessageEventContent)

An audio item.

File(FileMessageEventContent)

A file item.

Image(ImageMessageEventContent)

An image item.

Video(VideoMessageEventContent)

A video item.

Implementations

impl GalleryItemType

pub fn new( itemtype: &str, body: String, data: Map<String, Value>, ) -> Result<GalleryItemType, Error>

Creates a new GalleryItemType.

The itemtype and body are required fields. Additionally it’s possible to add arbitrary key/value pairs to the event content for custom item types through the data map.

Prefer to use the public variants of GalleryItemType where possible; this constructor is meant be used for unsupported item types only and does not allow setting arbitrary data for supported ones.

Errors

Returns an error if the itemtype is known and serialization of data to the corresponding GalleryItemType variant fails.

pub fn itemtype(&self) -> &str

Returns a reference to the itemtype string.

pub fn body(&self) -> &str

Return a reference to the itemtype body.

pub fn data(&self) -> Cow<'_, Map<String, Value>>

Returns the associated data.

The returned JSON object won’t contain the itemtype and body fields, use .itemtype() / .body() to access those.

Prefer to use the public variants of GalleryItemType where possible; this method is meant to be used for custom message types only.

Trait Implementations

impl Clone for GalleryItemType

fn clone(&self) -> GalleryItemType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GalleryItemType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GalleryItemType

Available on crate feature unstable-msc4274 only.

fn deserialize<D>( deserializer: D, ) -> Result<GalleryItemType, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GalleryItemType

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.