Struct Page 

pub struct Page<T> {
    pub items: Vec<T>,
    pub offset: u64,
    pub limit: u64,
}

One page of results plus the offset/limit window it represents. The API does not always return a total count, so it is omitted here.

Fields

items: Vec<T>

offset: u64

limit: u64

Implementations

impl<T> Page<T>

pub fn new(items: Vec<T>, offset: u64, limit: u64) -> Self

Build a page from a vector. offset and limit correspond to the query parameters that produced this page.

pub fn len(&self) -> usize

Number of items returned in this page (0..=limit).

pub fn is_empty(&self) -> bool

True if this page is empty.

pub fn is_probably_last(&self) -> bool

True if this page is “probably last” — i.e. fewer items than the page size were returned. Heuristic; some endpoints return exactly limit on the last page.

pub fn next_offset(&self) -> u64

The offset to request for the next page.

Trait Implementations

impl<T: Clone> Clone for Page<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Page<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Page<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> IntoIterator for Page<T>

Iterator helper: converts a Page<T> into an owned iterator over its items, discarding the window metadata.

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for Page<T>

fn eq(&self, other: &Page<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 Page<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 Page<T>

impl<T> StructuralPartialEq for Page<T>