Struct PagedRequest 

pub struct PagedRequest {
    pub page: u32,
    pub page_size: u32,
}

Fields

page: u32

page_size: u32

Implementations

impl PagedRequest

pub fn new(page: u32, page_size: u32) -> Self

pub fn from_parts(page: Option<u32>, page_size: Option<u32>) -> Self

Build a request from the two optional query fields of a list endpoint.

None falls back to the framework defaults (page 1, page size 20) and the result is clamped, so the binding layer may hand over Option<u32> without every handler repeating the defaults:

let defaults = PagedRequest::from_parts(None, None);
assert_eq!((defaults.page, defaults.page_size), (1, 20));

// Out-of-range values are clamped instead of rejected.
let zero = PagedRequest::from_parts(Some(0), Some(0));
assert_eq!((zero.page, zero.page_size), (1, 1));
let wide = PagedRequest::from_parts(Some(3), Some(1_000));
assert_eq!((wide.page, wide.page_size), (3, 100));

Equivalent to PagedRequest::new(page.unwrap_or(1), page_size.unwrap_or(20)).clamped().

pub fn offset(&self) -> u32

pub fn clamped(self) -> Self

Trait Implementations

impl Clone for PagedRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PagedRequest

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

Formats the value using the given formatter.

impl Default for PagedRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PagedRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.