Struct PageMeta 

pub struct PageMeta {
    pub next: Option<Url>,
    pub total_count: Option<u64>,
    pub limit: Option<u64>,
}

Available on crate feature transport only.

The three headers a paginated response carries.

Spec: 2.3.0 §transport_and_format_paginated_response

Fields

next: Option<Url>

The URL of the next page, present only when this is not the last page.

total_count: Option<u64>

The total number of objects matching the query, excluding limit and offset.

limit: Option<u64>

The maximum number of objects the server will return.

Note that this is an upper limit. If there are not enough remaining objects to return, fewer objects than this upper limit number will be returned, X-Limit SHALL then still show the upper limit, not the number of objects returned.

Implementations

impl PageMeta

pub fn from_headers(headers: &HeaderMap) -> Self

Reads the pagination headers from a response.

pub fn write_to(&self, headers: &mut HeaderMap)

Writes the pagination headers into a response.

pub const fn has_next(&self) -> bool

Whether there is another page to fetch.

Trait Implementations

impl Clone for PageMeta

fn clone(&self) -> PageMeta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PageMeta

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

Formats the value using the given formatter.

impl Default for PageMeta

fn default() -> PageMeta

Returns the “default value” for a type.

impl Eq for PageMeta

impl PartialEq for PageMeta

fn eq(&self, other: &PageMeta) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PageMeta