Struct Paged

pub struct Paged<E> { /* private fields */ }

A query modifier that paginates an endpoint.

Implementations

impl<E> Paged<E>

where E: Endpoint + Pageable,

pub fn iter<'a, C, T>( &'a self, client: &'a C, ) -> LazilyPagedIter<'a, &'a E, C, T>

Create an iterator over the results of paginated results for with a client.

pub fn into_iter<C, T>(self, client: &C) -> LazilyPagedIter<'_, E, C, T>

Create an iterator over the results of paginated results for with a client.

impl<E> Paged<E>

where E: Endpoint + Pageable + Sync,

pub fn iter_async<'a, C, T>( &'a self, client: &'a C, ) -> impl Stream<Item = Result<T, ApiError<C::Error>>> + 'a

where T: DeserializeOwned + 'static, C: AsyncClient + Sync,

Create a stream over the results of paginated results for with a client.

pub fn into_iter_async<'a, C, T>( self, client: &'a C, ) -> impl Stream<Item = Result<T, ApiError<C::Error>>> + 'a

where E: 'a, T: DeserializeOwned + 'static, C: AsyncClient + Sync,

Create a stream over the results of paginated results for with a client.

Trait Implementations

impl<E, T, C> AsyncQuery<Vec<T>, C> for Paged<E>

where E: Endpoint + Sync + Pageable, T: DeserializeOwned + Send + 'static, C: AsyncClient + Sync,

fn query_async<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 C, ) -> Pin<Box<dyn Future<Output = Result<Vec<T>, ApiError<C::Error>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform the query asynchronously against the client.

impl<E: Clone> Clone for Paged<E>

fn clone(&self) -> Paged<E>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<E: Debug> Debug for Paged<E>

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

Formats the value using the given formatter.

impl<E: PartialEq> PartialEq for Paged<E>

fn eq(&self, other: &Paged<E>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<E, T, C> Query<Vec<T>, C> for Paged<E>

where E: Endpoint + Pageable, T: DeserializeOwned + 'static, C: Client,

fn query(&self, client: &C) -> Result<Vec<T>, ApiError<C::Error>>

Perform the query against the client.

impl<E: Copy> Copy for Paged<E>

impl<E: Eq> Eq for Paged<E>

impl<E> StructuralPartialEq for Paged<E>