Struct ThreadedEventsLoader

Source

pub struct ThreadedEventsLoader<P: PaginableThread> { /* private fields */ }

Expand description

A paginator for a thread of events.

Implementations§

Source §

impl<P: PaginableThread> ThreadedEventsLoader

Source

pub fn new( room: P, root_event_id: OwnedEventId, tokens: PaginationTokens, ) -> Self

Create a new ThreadedEventsLoader, given a room implementation.

Source

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

Run a single pagination backwards, returning the next set of events and information whether we’ve reached the start of the thread.

Note: when the thread start is reached, the root event will be included in the result.

Source

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

Run a single pagination forwards, returning the next set of events and information whether we’ve reached the end of the thread.

Source

pub fn thread_root_event_id(&self) -> &EventId

Returns the root EventId for the thread.

Trait Implementations§

Source §

impl<P: PaginableThread> Debug for ThreadedEventsLoader

Available on non-tarpaulin_include only.

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for ThreadedEventsLoader
where P: 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,

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 §

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 §

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