Struct ruma_events::image::ImageEventContent

source ·
pub struct ImageEventContent {
    pub text: TextContentBlock,
    pub file: FileContentBlock,
    pub image_details: Option<ImageDetailsContentBlock>,
    pub thumbnail: ThumbnailContentBlock,
    pub caption: Option<CaptionContentBlock>,
    pub alt_text: Option<AltTextContentBlock>,
    pub automated: bool,
    pub relates_to: Option<Relation<ImageEventContentWithoutRelation>>,
}
Expand description

The payload for an extensible image message.

This is the new primary type introduced in MSC3552 and should only be sent in rooms with a version that supports it. This type replaces both the m.room.message type with msgtype: "m.image" and the m.sticker type. To replace the latter, sticker must be set to true in image_details. See the documentation of the message module for more information.

Fields§

§text: TextContentBlock

The text representation of the message.

§file: FileContentBlock

The file content of the message.

§image_details: Option<ImageDetailsContentBlock>

The image details of the message, if any.

§thumbnail: ThumbnailContentBlock

The thumbnails of the message, if any.

This is optional and defaults to an empty array.

§caption: Option<CaptionContentBlock>

The caption of the message, if any.

§alt_text: Option<AltTextContentBlock>

The alternative text of the image, for accessibility considerations, if any.

§automated: bool

Whether this message is automated.

§relates_to: Option<Relation<ImageEventContentWithoutRelation>>

Information about related messages.

Implementations§

source§

impl ImageEventContent

source

pub fn new(text: TextContentBlock, file: FileContentBlock) -> Self

Creates a new ImageEventContent with the given fallback representation and file.

source

pub fn with_plain_text( plain_text: impl Into<String>, file: FileContentBlock ) -> Self

Creates a new ImageEventContent with the given plain text fallback representation and file.

Trait Implementations§

source§

impl Clone for ImageEventContent

source§

fn clone(&self) -> ImageEventContent

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 ImageEventContent

source§

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

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

impl<'de> Deserialize<'de> for ImageEventContent

source§

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

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

impl EventContent for ImageEventContent

§

type EventType = MessageLikeEventType

The Rust enum for the event kind’s known types.
source§

fn event_type(&self) -> Self::EventType

Get the event’s type, like m.room.message.
source§

impl From<ImageEventContent> for AnyMessageLikeEventContent

source§

fn from(c: ImageEventContent) -> Self

Converts to this type from the input type.
source§

impl From<ImageEventContent> for ImageEventContentWithoutRelation

source§

fn from(c: ImageEventContent) -> Self

Converts to this type from the input type.
source§

impl RedactContent for ImageEventContent

§

type Redacted = RedactedImageEventContent

The redacted form of the event’s content.
source§

fn redact(self, version: &RoomVersionId) -> RedactedImageEventContent

Transform self into a redacted form (removing most or all fields) according to the spec. Read more
source§

impl Serialize for ImageEventContent

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl StaticEventContent for ImageEventContent

source§

const TYPE: &'static str = "org.matrix.msc1767.image"

The event type.
source§

impl MessageLikeEventContent for ImageEventContent

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> EventContentFromType for T

source§

fn from_parts(_event_type: &str, content: &RawValue) -> Result<T, Error>

Constructs this event content from the given event type and JSON.
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>,