Enum LatestEventValue 

pub enum LatestEventValue {
    None,
    Remote(RemoteLatestEventValue),
    RemoteInvite {
        event_id: Option<OwnedEventId>,
        timestamp: MilliSecondsSinceUnixEpoch,
        inviter: Option<OwnedUserId>,
    },
    LocalIsSending(LocalLatestEventValue),
    LocalHasBeenSent {
        event_id: OwnedEventId,
        value: LocalLatestEventValue,
    },
    LocalCannotBeSent(LocalLatestEventValue),
}

A latest event value!

Variants

None

No value has been computed yet, or no candidate value was found.

Remote(RemoteLatestEventValue)

The latest event represents a remote event.

RemoteInvite

The latest event represents an invite, i.e. the current user has been invited to join a room.

Fields

event_id: Option<OwnedEventId>

The ID of the invite event.

timestamp: MilliSecondsSinceUnixEpoch

The timestamp of the invite event.

inviter: Option<OwnedUserId>

The user ID of the inviter.

LocalIsSending(LocalLatestEventValue)

The latest event represents a local event that is sending.

LocalHasBeenSent

The latest event represents a local event that has been sent successfully. It should come quickly as a Self::Remote.

Fields

event_id: OwnedEventId

ID of the sent event.

value: LocalLatestEventValue

Value, as for other Self::Local* variants.

LocalCannotBeSent(LocalLatestEventValue)

The latest event represents a local event that cannot be sent, either because a previous local event, or this local event cannot be sent.

Implementations

impl LatestEventValue

pub fn timestamp(&self) -> Option<MilliSecondsSinceUnixEpoch>

Get the timestamp of the LatestEventValue.

• If it’s None, it returns None.
• If it’s Remote, it returns the TimelineEvent::timestamp.
• If it’s RemoteInvite, it returns the SyncOrStrippedState::timestamp.
• If it’s LocalIsSending,LocalHasBeenSent or LocalCannotBeSent, it returns the LocalLatestEventValue::timestamp value.

pub fn is_local(&self) -> bool

Check whether the LatestEventValue represents a local value or not, i.e. it is LocalIsSending or LocalCannotBeSent.

pub fn is_unsent(&self) -> bool

Check whether the LatestEventValue represents an unsent event, i.e. is LocalIsSending nor LocalCannotBeSent.

pub fn is_none(&self) -> bool

Check whether the LatestEventValue is not set, i.e. None.

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

Get the event ID (if it exists) of the event representing the LatestEventValue.

Trait Implementations

impl Clone for LatestEventValue

fn clone(&self) -> LatestEventValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LatestEventValue

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

Formats the value using the given formatter.

impl Default for LatestEventValue

fn default() -> LatestEventValue

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LatestEventValue

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LatestEventValue

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

where __S: Serializer,

Serialize this value into the given Serde serializer.