Struct Annotation

#[non_exhaustive]
pub struct Annotation {
    pub event_id: OwnedEventId,
    pub key: String,
}

Available on crate feature events only.

An annotation for an event.

Fields (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.

event_id: OwnedEventId

The event that is being annotated.

key: String

A string that indicates the annotation being applied.

When sending emoji reactions, this field should include the colourful variation-16 when applicable.

Clients should render reactions that have a long key field in a sensible manner.

Implementations

impl Annotation

pub fn new(event_id: OwnedEventId, key: String) -> Annotation

Creates a new Annotation with the given event ID and key.

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Annotation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Annotation> for ReactionEventContent

fn from(relates_to: Annotation) -> ReactionEventContent

Converts to this type from the input type.

impl Serialize for Annotation

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.