Struct Paginator

pub struct Paginator<PR: PaginableRoom> { /* private fields */ }

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

See also the module-level documentation.

Implementations

impl<PR: PaginableRoom> Paginator<PR>

pub fn new(room: PR) -> Self

Create a new Paginator, given a room implementation.

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

Returns a subscriber to the internal PaginatorState machine.

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.

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.

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.

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.

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

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

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

Formats the value using the given formatter.