Struct Paginated 

#[non_exhaustive]
pub struct Paginated<T> {
    pub data: Vec<T>,
    pub has_more: bool,
    pub first_id: Option<String>,
    pub last_id: Option<String>,
}

One page of items returned from a paginated list endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

data: Vec<T>

Items on this page.

has_more: bool

Whether more pages exist after this one.

first_id: Option<String>

ID of the first item on this page (cursor for before_id).

last_id: Option<String>

ID of the last item on this page (cursor for after_id).

Implementations

impl<T> Paginated<T>

pub fn next_after(&self) -> Option<&str>

Cursor for the next page (forward direction): the last_id of this page, suitable for the next request’s after_id parameter. Returns None if there are no more pages.

pub fn next_before(&self) -> Option<&str>

Cursor for the previous page (backward direction): the first_id of this page, for the next request’s before_id parameter.

pub fn is_empty(&self) -> bool

Whether the page itself is empty.

Trait Implementations

impl<T: Clone> Clone for Paginated<T>

fn clone(&self) -> Paginated<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Paginated<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Paginated<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for Paginated<T>

fn eq(&self, other: &Paginated<T>) -> 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<T> Serialize for Paginated<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for Paginated<T>

impl<T> StructuralPartialEq for Paginated<T>