Relation

ruma::events::room::message

Enum Relation

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

Available on crate feature events only.

Expand description

Message event relationship.

Variants (Non-exhaustive)§

This enum is marked as 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 duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<C> Debug for Relation<C>
where C: Debug,

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

Formats the value using the given formatter. Read more

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. Read more

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.

Auto Trait Implementations§

impl<C> Freeze for Relation<C>
where C: Freeze,

impl<C> RefUnwindSafe for Relation<C>
where C: RefUnwindSafe,

impl<C> Send for Relation<C>
where C: Send,

impl<C> Sync for Relation<C>
where C: Sync,

impl<C> Unpin for Relation<C>
where C: Unpin,

impl<C> UnwindSafe for Relation<C>
where C: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

const WITNESS: W = W::MAKE

A constant of the type witness

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

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.

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

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> JsonCastable<CanonicalJsonValue> for T

impl<T> JsonCastable<Value> for T