Struct ruma::events::room::message::ImageMessageEventContent

source ·
#[non_exhaustive]
pub struct ImageMessageEventContent { pub body: String, pub formatted: Option<FormattedBody>, pub filename: Option<String>, pub source: MediaSource, pub info: Option<Box<ImageInfo>>, }
Expand description

The payload for an image message.

Fields (Non-exhaustive)§

This struct is marked as 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.
§body: String

A textual representation of the image.

If the filename field is not set or has the same value, this is the filename of the uploaded file. Otherwise, this should be interpreted as a user-written media caption.

§formatted: Option<FormattedBody>

Formatted form of the message body.

This should only be set if the body represents a caption.

§filename: Option<String>

The original filename of the uploaded file as deserialized from the event.

It is recommended to use the filename method to get the filename which automatically falls back to the body field when the filename field is not set.

§source: MediaSource

The source of the image.

§info: Option<Box<ImageInfo>>

Metadata about the image referred to in source.

Implementations§

source§

impl ImageMessageEventContent

source

pub fn new(body: String, source: MediaSource) -> ImageMessageEventContent

Creates a new ImageMessageEventContent with the given body and source.

source

pub fn plain(body: String, url: OwnedMxcUri) -> ImageMessageEventContent

Creates a new non-encrypted ImageMessageEventContent with the given body and url.

source

pub fn encrypted(body: String, file: EncryptedFile) -> ImageMessageEventContent

Creates a new encrypted ImageMessageEventContent with the given body and encrypted file.

source

pub fn info( self, info: impl Into<Option<Box<ImageInfo>>>, ) -> ImageMessageEventContent

Creates a new ImageMessageEventContent from self with the info field set to the given value.

Since the field is public, you can also assign to it directly. This method merely acts as a shorthand for that, because it is very common to set this field.

source

pub fn filename(&self) -> &str

Computes the filename of the image as defined by the spec.

This differs from the filename field as this method falls back to the body field when the filename field is not set.

source

pub fn caption(&self) -> Option<&str>

Returns the caption for the image as defined by the spec.

In short, this is the body field if the filename field exists and has a different value, otherwise the media file does not have a caption.

source

pub fn formatted_caption(&self) -> Option<&FormattedBody>

Returns the formatted caption for the image as defined by the spec.

This is the same as caption, but returns the formatted body instead of the plain body.

Trait Implementations§

source§

impl Clone for ImageMessageEventContent

source§

fn clone(&self) -> ImageMessageEventContent

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ImageMessageEventContent

source§

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

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

impl<'de> Deserialize<'de> for ImageMessageEventContent

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Serialize for ImageMessageEventContent

source§

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. 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§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

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

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

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

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

§

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>,

§

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>,

§

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

source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,