Struct Receipts

#[non_exhaustive]
pub struct Receipts {
    pub fully_read: Option<OwnedEventId>,
    pub public_read_receipt: Option<OwnedEventId>,
    pub private_read_receipt: Option<OwnedEventId>,
}

Receipts to send all at once.

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.

fully_read: Option<OwnedEventId>

Fully-read marker (room account data).

public_read_receipt: Option<OwnedEventId>

Read receipt (public ephemeral room event).

private_read_receipt: Option<OwnedEventId>

Read receipt (private ephemeral room event).

Implementations

impl Receipts

pub fn new() -> Self

Create an empty Receipts.

pub fn fully_read_marker( self, event_id: impl Into<Option<OwnedEventId>>, ) -> Self

Set the last event the user has read.

It means that the user has read all the events before this event.

This is a private marker only visible by the user.

Note that this is technically not a receipt as it is persisted in the room account data.

pub fn public_read_receipt( self, event_id: impl Into<Option<OwnedEventId>>, ) -> Self

Set the last event presented to the user and forward it to the other users in the room.

This is used to reset the unread messages/notification count and advertise to other users the last event that the user has likely seen.

pub fn private_read_receipt( self, event_id: impl Into<Option<OwnedEventId>>, ) -> Self

Set the last event presented to the user and don’t forward it.

This is used to reset the unread messages/notification count.

pub fn is_empty(&self) -> bool

Whether this Receipts is empty.

Trait Implementations

impl Clone for Receipts

fn clone(&self) -> Receipts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Receipts

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

Formats the value using the given formatter.

impl Default for Receipts

fn default() -> Receipts

Returns the “default value” for a type.