Struct PageRequest

pub struct PageRequest {
    pub key: Vec<u8>,
    pub offset: u64,
    pub limit: u64,
    pub count_total: bool,
    pub reverse: bool,
}

Fields

key: Vec<u8>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

offset: u64

offset is a numeric offset that can be used when the key is unavailable. It is less efficient than using the key. Only one of offset or key should be set.

limit: u64

limit is the total number of results to be returned to the result page. If left empty, it will default to a value to be set by each app.

count_total: bool

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

reverse: bool

reverse is set to true if results are to be returned in the descending order.

Implementations

impl PageRequest

pub fn all() -> Self

Trait Implementations

impl Clone for PageRequest

fn clone(&self) -> PageRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PageRequest

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

Formats the value using the given formatter.

impl Default for PageRequest

fn default() -> PageRequest

Returns the “default value” for a type.

impl From<PageRequest> for PageRequest

fn from(request: PageRequest) -> Self

Converts to this type from the input type.

impl From<PageRequest> for PageRequest

fn from(request: RawPageRequest) -> Self

Converts to this type from the input type.