Struct HttpPaginationOptions 

pub struct HttpPaginationOptions {
    pub limit: Option<u64>,
    pub offset: Option<u64>,
    pub reverse: Option<bool>,
}

HTTP pagination options allow for lazy reading of large sets of data, for example if thousands of messages have been sent and received from a phone number it would be impractical to request all of them at the same time, instead it can be read in shorter pages using limit+offset. This is applied at the server level when requesting data from database.

Fields

limit: Option<u64>

The maximum amount of return values.

offset: Option<u64>

The offset in index to start getting values from. Eg, if the limit was 5, and you want to view page 2, the offset would be 5, then 10, 15, …

reverse: Option<bool>

Should return values be reversed? This is useful for getting the first results from a large set without having to know it’s size.

Implementations

impl HttpPaginationOptions

pub fn with_limit(self, limit: u64) -> Self

Set the limit/page size.

pub fn with_offset(self, offset: u64) -> Self

Set request position offset.

pub fn with_reverse(self, reverse: bool) -> Self

Set the reverse state for options.

pub fn add_to_body(&self, body: &mut Value)

Add pagination options to a json Value.

Trait Implementations

impl Clone for HttpPaginationOptions

fn clone(&self) -> HttpPaginationOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpPaginationOptions

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

Formats the value using the given formatter.

impl Default for HttpPaginationOptions

fn default() -> HttpPaginationOptions

Returns the “default value” for a type.

impl PartialEq for HttpPaginationOptions

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for HttpPaginationOptions

impl StructuralPartialEq for HttpPaginationOptions