Struct LatestEvent

pub struct LatestEvent { /* private fields */ }

Represent all information required to represent a latest event in an efficient way.

Implementation details

Serialization and deserialization should be a breeze, but we introduced a change in the format without realizing, and without a migration. Ideally, this would be handled with a serde(untagged) enum that would be used to deserialize in either the older format, or to the new format. Unfortunately, untagged enums don’t play nicely with serde_json::value::RawValue, so we did have to implement a custom Deserialize for LatestEvent, that first deserializes the thing as a raw JSON value, and then deserializes the JSON string as one variant or the other.

Because of that, LatestEvent should only be (de)serialized using serde_json.

Whenever you introduce new fields to LatestEvent make sure to add them to SerializedLatestEvent too.

Implementations

impl LatestEvent

pub fn new(event: TimelineEvent) -> Self

Create a new LatestEvent without the sender’s profile.

pub fn new_with_sender_details( event: TimelineEvent, sender_profile: Option<MinimalRoomMemberEvent>, sender_name_is_ambiguous: Option<bool>, ) -> Self

Create a new LatestEvent with maybe the sender’s profile.

pub fn into_event(self) -> TimelineEvent

Transform Self into an event.

pub fn event(&self) -> &TimelineEvent

Get a reference to the event.

pub fn event_mut(&mut self) -> &mut TimelineEvent

Get a mutable reference to the event.

pub fn event_id(&self) -> Option<OwnedEventId>

Get the event ID.

pub fn has_sender_profile(&self) -> bool

Check whether Self has a sender profile.

pub fn sender_display_name(&self) -> Option<&str>

Return the sender’s display name if it was known at the time Self was built.

pub fn sender_name_ambiguous(&self) -> Option<bool>

Return Some(true) if the sender’s name is ambiguous, Some(false) if it isn’t, None if ambiguity detection wasn’t possible at the time Self was built.

pub fn sender_avatar_url(&self) -> Option<&MxcUri>

Return the sender’s avatar URL if it was known at the time Self was built.

Trait Implementations

impl Clone for LatestEvent

fn clone(&self) -> LatestEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LatestEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LatestEvent

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LatestEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.