Struct matrix_sdk::event_cache::RoomEventCache
source · pub struct RoomEventCache { /* private fields */ }
Expand description
A subset of an event cache, for a room.
Cloning is shallow, and thus is cheap to do.
Implementations§
source§impl RoomEventCache
impl RoomEventCache
sourcepub async fn subscribe(
&self,
) -> Result<(Vec<SyncTimelineEvent>, Receiver<RoomEventCacheUpdate>)>
pub async fn subscribe( &self, ) -> Result<(Vec<SyncTimelineEvent>, Receiver<RoomEventCacheUpdate>)>
Subscribe to room updates for this room, after getting the initial list
of events. XXX: Could/should it use some kind of Observable
instead? Or not something async, like explicit handlers as our event
handlers?
sourcepub fn pagination(&self) -> RoomPagination
pub fn pagination(&self) -> RoomPagination
Return a RoomPagination
API object useful for running
back-pagination queries in the current room.
sourcepub async fn event(&self, event_id: &EventId) -> Option<SyncTimelineEvent>
pub async fn event(&self, event_id: &EventId) -> Option<SyncTimelineEvent>
Try to find an event by id in this room.
sourcepub async fn event_with_relations(
&self,
event_id: &EventId,
filter: Option<Vec<RelationType>>,
) -> Option<(SyncTimelineEvent, Vec<SyncTimelineEvent>)>
pub async fn event_with_relations( &self, event_id: &EventId, filter: Option<Vec<RelationType>>, ) -> Option<(SyncTimelineEvent, Vec<SyncTimelineEvent>)>
Try to find an event by id in this room, along with its related events.
You can filter which types of related events to retrieve using
filter
. None
will retrieve related events of any type.
Trait Implementations§
source§impl Clone for RoomEventCache
impl Clone for RoomEventCache
source§fn clone(&self) -> RoomEventCache
fn clone(&self) -> RoomEventCache
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreAuto Trait Implementations§
impl Freeze for RoomEventCache
impl !RefUnwindSafe for RoomEventCache
impl Send for RoomEventCache
impl Sync for RoomEventCache
impl Unpin for RoomEventCache
impl !UnwindSafe for RoomEventCache
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
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
source§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>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more