Struct matrix_sdk::room::Receipts
source · #[non_exhaustive]pub struct Receipts {
pub fully_read: Option<OwnedEventId>,
pub public_read_receipt: Option<OwnedEventId>,
pub private_read_receipt: Option<OwnedEventId>,
}
Expand description
Receipts to send all at once.
Fields (Non-exhaustive)§
This struct is marked as 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§
source§impl Receipts
impl Receipts
sourcepub fn fully_read_marker(
self,
event_id: impl Into<Option<OwnedEventId>>
) -> Self
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.
sourcepub fn public_read_receipt(
self,
event_id: impl Into<Option<OwnedEventId>>
) -> Self
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.
sourcepub fn private_read_receipt(
self,
event_id: impl Into<Option<OwnedEventId>>
) -> Self
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.
Trait Implementations§
Auto Trait Implementations§
impl RefUnwindSafe for Receipts
impl Send for Receipts
impl Sync for Receipts
impl Unpin for Receipts
impl UnwindSafe for Receipts
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> CompatExt for T
impl<T> CompatExt for T
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
§impl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
§fn new_handle(value: Arc<T>) -> Handle
fn new_handle(value: Arc<T>) -> Handle
Create a new handle for an Arc value Read more
§fn clone_handle(handle: Handle) -> Handle
fn clone_handle(handle: Handle) -> Handle
Clone a handle Read more
§fn consume_handle(handle: Handle) -> Arc<T>
fn consume_handle(handle: Handle) -> Arc<T>
Consume a handle, getting back the initial
Arc<>
§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
Read this value from the supplied reader. Same as
ReadEndian::read_from_little_endian()
.