Struct PageParams 

pub struct PageParams<const MAX: u64 = 100, const DEFAULT: u64 = 20> {
    pub page: Option<u64>,
    pub per_page: Option<u64>,
}

?page=N&per_page=M: a 1-based page and a page size from 1 to MAX, DEFAULT when absent.

Out-of-range or non-numeric values are rejected with 422 before the handler runs, and the documented query parameters state the bounds. Use it as Query<PageParams> (at most 100, default 20) or choose the bounds: Query<PageParams<500, 50>>.

Fields

page: Option<u64>

1-based page number.

per_page: Option<u64>

Items per page.

Implementations

impl<const MAX: u64, const DEFAULT: u64> PageParams<MAX, DEFAULT>

pub fn page(&self) -> u64

The requested page, 1 when absent.

pub fn per_page(&self) -> u64

The requested page size, DEFAULT when absent.

pub async fn fetch<M: Model>(&self, queryset: QuerySet<M>) -> Fetched<M>

Fetch this page of queryset (one count, one fetch).

Errors

Capability or backend errors of the queryset.

Trait Implementations

impl<const MAX: u64, const DEFAULT: u64> Clone for PageParams<MAX, DEFAULT>

fn clone(&self) -> PageParams<MAX, DEFAULT>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MAX: u64, const DEFAULT: u64> Copy for PageParams<MAX, DEFAULT>

impl<const MAX: u64, const DEFAULT: u64> Debug for PageParams<MAX, DEFAULT>

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

Formats the value using the given formatter.

impl<const MAX: u64, const DEFAULT: u64> Default for PageParams<MAX, DEFAULT>

fn default() -> PageParams<MAX, DEFAULT>

Returns the “default value” for a type.

impl<'de, const MAX: u64, const DEFAULT: u64> Deserialize<'de> for PageParams<MAX, DEFAULT>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const MAX: u64, const DEFAULT: u64> Eq for PageParams<MAX, DEFAULT>

impl<const MAX: u64, const DEFAULT: u64> PartialEq for PageParams<MAX, DEFAULT>

fn eq(&self, other: &PageParams<MAX, DEFAULT>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<const MAX: u64, const D: u64> Schema for PageParams<MAX, D>

fn schema(_: &mut SchemaRegistry) -> SchemaObject

The schema definition of this type. Use SchemaRegistry::subschema for nested types.

fn schema_name() -> Option<&'static str>

Stable component name. Named types are emitted once under components.schemas and referenced with $ref.

impl<const MAX: u64, const DEFAULT: u64> StructuralPartialEq for PageParams<MAX, DEFAULT>

impl<const MAX: u64, const D: u64> Validate for PageParams<MAX, D>

fn prepare(input: &mut Value, ctx: &mut ValidationContext)

Check and normalise the raw input for this type in place.

fn validate(&self, _ctx: &mut ValidationContext)

Check invariants of the deserialized value.