Struct ruma_common::events::file::FileEventContent

pub struct FileEventContent {
    pub message: MessageContent,
    pub file: FileContent,
    pub relates_to: Option<Relation>,
}

Available on crate features events and unstable-msc3551 only.

The payload for an extensible file message.

This is the new primary type introduced in MSC3551 and should not be sent before the end of the transition period. See the documentation of the message module for more information.

FileEventContent can be converted to a RoomMessageEventContent with a MessageType::File. You can convert it back with FileEventContent::from_file_room_message().

Fields

message: MessageContent

The text representation of the message.

file: FileContent

The file content of the message.

relates_to: Option<Relation>

Information about related messages.

Implementations

impl FileEventContent

pub fn plain(
    message: impl Into<String>,
    url: OwnedMxcUri,
    info: Option<Box<FileContentInfo>>
) -> Self

Creates a new non-encrypted FileEventContent with the given plain text message, url and file info.

pub fn plain_message(
    message: MessageContent,
    url: OwnedMxcUri,
    info: Option<Box<FileContentInfo>>
) -> Self

Creates a new non-encrypted FileEventContent with the given message, url and file info.

pub fn encrypted(
    message: impl Into<String>,
    url: OwnedMxcUri,
    encryption_info: EncryptedContent,
    info: Option<Box<FileContentInfo>>
) -> Self

Creates a new encrypted FileEventContent with the given plain text message, url, encryption info and file info.

pub fn encrypted_message(
    message: MessageContent,
    url: OwnedMxcUri,
    encryption_info: EncryptedContent,
    info: Option<Box<FileContentInfo>>
) -> Self

Creates a new encrypted FileEventContent with the given message, url, encryption info and file info.

pub fn from_file_room_message(
    content: FileMessageEventContent,
    relates_to: Option<Relation>
) -> Self

Create a new FileEventContent from the given FileMessageEventContent and optional relation.

Trait Implementations

impl Clone for FileEventContent

fn clone(&self) -> FileEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileEventContent

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

Deserialize this value from the given Serde deserializer.

impl EventContent for FileEventContent

type EventType = MessageLikeEventType

Available on crate feature events only.

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

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

Available on crate feature events only.

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

impl From<FileEventContent> for AnyMessageLikeEventContent

fn from(c: FileEventContent) -> Self

Converts to this type from the input type.

impl From<FileEventContent> for RoomMessageEventContent

fn from(content: FileEventContent) -> Self

Converts to this type from the input type.

impl RedactContent for FileEventContent

type Redacted = RedactedFileEventContent

Available on crate feature events only.

The redacted form of the event’s content.

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

Available on crate feature events only.

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

impl Serialize for FileEventContent

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

Serialize this value into the given Serde serializer.

impl StaticEventContent for FileEventContent

const KIND: EventKind = ::ruma_common::events::EventKind::MessageLike{redacted: false,}

Available on crate feature events only.

The event’s “kind”.

const TYPE: &'static str = "m.file"

Available on crate feature events only.

The event type.