Struct PaginationQuery 

pub struct PaginationQuery<'a> {
    pub before: Option<&'a str>,
    pub after: Option<&'a str>,
    pub limit: Option<u32>,
    pub order: Option<PaginationOrder>,
}

The standard pagination query parameters accepted by most list endpoints.

List request structs embed this and pass its values into query_pairs_mut when building the URL.

Fields

before: Option<&'a str>

A cursor for pagination: the object ID that defines the place in the list before which items are returned.

after: Option<&'a str>

A cursor for pagination: the object ID that defines the place in the list after which items are returned.

limit: Option<u32>

A limit on the number of objects to be returned (1-100, default 20 for most endpoints).

order: Option<PaginationOrder>

The sort order of the returned objects.

Implementations

impl<'a> PaginationQuery<'a>

pub fn append_to<T: Target>(&self, pairs: &mut Serializer<'_, T>)

Appends the set parameters to pairs.

pub fn any_set(&self) -> bool

Whether any parameter is set.

Trait Implementations

impl<'a> Clone for PaginationQuery<'a>

fn clone(&self) -> PaginationQuery<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for PaginationQuery<'a>

impl<'a> Debug for PaginationQuery<'a>

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

Formats the value using the given formatter.

impl<'a> Default for PaginationQuery<'a>

fn default() -> PaginationQuery<'a>

Returns the “default value” for a type.