Enum matrix_sdk_base::ruma::events::room::message::Relation

#[non_exhaustive]
pub enum Relation<C> {
    Reply {
        in_reply_to: InReplyTo,
    },
    Replacement(Replacement<C>),
    Thread(Thread),
}

Message event relationship.

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.

Reply

An m.in_reply_to relation indicating that the event is a reply to another event.

Fields

in_reply_to: InReplyTo

Information about another message being replied to.

Replacement(Replacement<C>)

An event that replaces another event.

Thread(Thread)

An event that belongs to a thread.

Implementations

impl<C> Relation<C>

pub fn rel_type(&self) -> Option<RelationType>

The type of this Relation.

Returns an Option because the Reply relation does not have arel_type field.

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

where C: Clone,

The associated data.

The returned JSON object holds the contents of m.relates_to, including rel_type and event_id if present, but not things like m.new_content for m.replace relations that live next to m.relates_to.

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

Trait Implementations

impl<C> Clone for Relation<C>

where C: Clone,

fn clone(&self) -> Relation<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Debug for Relation<C>

where C: Debug,

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

Formats the value using the given formatter.

impl<C> From<Relation<C>> for Relation

fn from(rel: Relation<C>) -> Relation

Converts to this type from the input type.

impl<C> Serialize for Relation<C>

where C: Clone + Serialize,

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.

impl<C> TryFrom<Relation<C>> for RelationWithoutReplacement

type Error = Replacement<C>

The type returned in the event of a conversion error.

fn try_from( value: Relation<C>, ) -> Result<RelationWithoutReplacement, <RelationWithoutReplacement as TryFrom<Relation<C>>>::Error>

Performs the conversion.