Struct ably::http::PaginatedRequestBuilder

pub struct PaginatedRequestBuilder<'a, T: Decode> { /* private fields */ }

A builder to construct a paginated REST request.

Implementations

impl<'a, T: Decode + 'a> PaginatedRequestBuilder<'a, T>

pub fn new(inner: RequestBuilder<'a>, options: T::Options) -> Self

pub fn start(self, interval: &str) -> Self

Set the start interval of the request.

pub fn end(self, interval: &str) -> Self

Set the end interval of the request.

pub fn forwards(self) -> Self

Paginate forwards.

pub fn backwards(self) -> Self

Paginate backwards.

pub fn limit(self, limit: u32) -> Self

Limit the number of results per page.

pub fn params<P: Serialize + ?Sized>(self, params: &P) -> Self

Modify the query params of the request, adding the parameters provided.

pub fn pages(self) -> impl Stream<Item = Result<PaginatedResult<T>>> + 'a

Request a stream of pages from the Ably REST API.

pub async fn send(self) -> Result<PaginatedResult<T>>

Retrieve the first page of the paginated response.