Struct matrix_sdk::event_cache::RoomPagination

source ·
pub struct RoomPagination { /* private fields */ }
Expand description

An API object to run pagination queries on a super::RoomEventCache.

Can be created with super::RoomEventCache::pagination().

Implementations§

source§

impl RoomPagination

source

pub async fn run_backwards<Until, Break, UntilFuture>( &self, batch_size: u16, until: Until, ) -> Result<Break>
where Until: FnMut(BackPaginationOutcome, TimelineHasBeenResetWhilePaginating) -> UntilFuture, UntilFuture: Future<Output = ControlFlow<Break, ()>>,

Starts a back-pagination for the requested number of events.

This automatically takes care of waiting for a pagination token from sync, if we haven’t done that before.

The until argument is an async closure that returns a ControlFlow to decide whether a new pagination must be run or not. It’s helpful when the server replies with e.g. a certain set of events, but we would like more, or the event we are looking for isn’t part of this set: in this case, until returns ControlFlow::Continue, otherwise it returns ControlFlow::Break. until receives BackPaginationOutcome as its sole argument.

§Errors

It may return an error if the pagination token used during back-pagination has disappeared while we started the pagination. In that case, it’s desirable to call the method again.

§Example

To do a single run:

use std::ops::ControlFlow;

use matrix_sdk::event_cache::{
    BackPaginationOutcome,
    RoomPagination,
    TimelineHasBeenResetWhilePaginating
};

let result = room_pagination.run_backwards(
    42,
    |BackPaginationOutcome { events, reached_start },
     _timeline_has_been_reset: TimelineHasBeenResetWhilePaginating| async move {
        // Do something with `events` and `reached_start` maybe?
        let _ = events;
        let _ = reached_start;

        ControlFlow::Break(())
    }
).await;
source

pub fn status(&self) -> Subscriber<PaginatorState>

Returns a subscriber to the pagination status used for the back-pagination integrated to the event cache.

source

pub fn hit_timeline_start(&self) -> bool

Returns whether we’ve hit the start of the timeline.

This is true if, and only if, we didn’t have a previous-batch token and running backwards pagination would be useless.

source

pub fn hit_timeline_end(&self) -> bool

Returns whether we’ve hit the end of the timeline.

This is true if, and only if, we didn’t have a next-batch token and running forwards pagination would be useless.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> Any for T
where T: Any,

source§

impl<T> SendOutsideWasm for T
where T: Send,

source§

impl<T> SyncOutsideWasm for T
where T: Sync,