Struct fiberplane_models::paging::Pagination

#[non_exhaustive]
pub struct Pagination {
    pub page: u32,
    pub limit: u32,
}

A struct that represents the pagination of a list endpoint.

Some list endpoints support pagination by passing in querystring parameters, which are page and limit. This Pagination object is used to be used within api client when making a request.

Note that not all endpoints support pagination and some endpoints might ignore values that are too high.

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.

page: u32

limit: u32

Implementations

impl Pagination

pub fn builder() -> PaginationBuilder<((), ())>

Create a builder for building Pagination. On the builder, call .page(...), .limit(...) to set the values of the fields. Finally, call .build() to create the instance of Pagination.

impl Pagination

pub fn limit(&self) -> i64

The number of items to return.

pub fn offset(&self) -> i64

The number of items to skip. This is the same as page * limit.

pub fn max() -> Self

Create a pagination that effectively fetches every item (since limit is set to the max value).

Note that some endpoints might ignore setting this value this high.

Trait Implementations

impl Clone for Pagination

fn clone(&self) -> Pagination

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pagination

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

Formats the value using the given formatter.

impl Default for Pagination

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Pagination

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Pagination

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Pagination

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Pagination

impl StructuralPartialEq for Pagination