Struct matrix_sdk::event_cache::paginator::Paginator

source ·
pub struct Paginator<PR: PaginableRoom> { /* private fields */ }
Expand description

A stateful object to reach to an event, and then paginate backward and forward from it.

See also the module-level documentation.

Implementations§

source§

impl<PR: PaginableRoom> Paginator<PR>

source

pub fn new(room: PR) -> Self

Create a new Paginator, given a room implementation.

source

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

Returns a subscriber to the internal PaginatorState machine.

source

pub async fn start_from( &self, event_id: &EventId, num_events: UInt, ) -> Result<StartFromResult, PaginatorError>

Starts the pagination from the initial event, requesting num_events additional context events.

Only works for fresh Paginator objects, which are in the PaginatorState::Initial state.

source

pub async fn paginate_backward( &self, num_events: UInt, ) -> Result<PaginationResult, PaginatorError>

Runs a backward pagination (requesting num_events to the server), from the current state of the object.

Will return immediately if we have already hit the start of the timeline.

May return an error if it’s already paginating, or if the call to /messages failed.

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.

source

pub async fn paginate_forward( &self, num_events: UInt, ) -> Result<PaginationResult, PaginatorError>

Runs a forward pagination (requesting num_events to the server), from the current state of the object.

Will return immediately if we have already hit the end of the timeline.

May return an error if it’s already paginating, or if the call to /messages failed.

Trait Implementations§

source§

impl<PR: PaginableRoom> Debug for Paginator<PR>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<PR> !Freeze for Paginator<PR>

§

impl<PR> RefUnwindSafe for Paginator<PR>
where PR: RefUnwindSafe,

§

impl<PR> Send for Paginator<PR>

§

impl<PR> Sync for Paginator<PR>

§

impl<PR> Unpin for Paginator<PR>
where PR: Unpin,

§

impl<PR> UnwindSafe for Paginator<PR>
where PR: UnwindSafe,

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> AsyncTraitDeps for T

source§

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

source§

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