Skip to main content

Paginator

Struct Paginator 

Source
pub struct Paginator<T, F> { /* private fields */ }
Expand description

Lazily walks every page of a cursor list. Create with crate::Client::paginate or paginate.

use opensms::ListMessages;

let mut it = client.paginate(|cursor| {
    client.messages().list(ListMessages { limit: Some(50), cursor, ..Default::default() })
});
while let Some(message) = it.next().await {
    println!("{}", message?.id);
}

Implementations§

Source§

impl<T, F, Fut> Paginator<T, F>
where F: FnMut(Option<String>) -> Fut, Fut: Future<Output = Result<Page<T>>>,

Source

pub async fn next(&mut self) -> Option<Result<T>>

The next item, fetching the next page when needed. None when every page has been read. After an error, iteration stops.

Source

pub async fn collect_all(self) -> Result<Vec<T>>

Read every remaining item into a Vec.

Auto Trait Implementations§

§

impl<T, F> Forget for Paginator<T, F>

§

impl<T, F> Freeze for Paginator<T, F>
where F: Freeze, VecDeque<T>: Freeze,

§

impl<T, F> Move for Paginator<T, F>

§

impl<T, F> RefUnwindSafe for Paginator<T, F>

§

impl<T, F> Send for Paginator<T, F>
where F: Send, VecDeque<T>: Send,

§

impl<T, F> Sync for Paginator<T, F>
where F: Sync, VecDeque<T>: Sync,

§

impl<T, F> Unpin for Paginator<T, F>
where F: Unpin, VecDeque<T>: Unpin,

§

impl<T, F> UnsafeUnpin for Paginator<T, F>

§

impl<T, F> UnwindSafe for Paginator<T, F>

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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