Struct PaginationParams 

pub struct PaginationParams {
    pub limit: Option<u32>,
    pub offset: Option<u32>,
}

Query parameters for paginated list endpoints.

Fields

limit: Option<u32>

Maximum number of results to return (default: 50).

offset: Option<u32>

Number of results to skip (default: 0).

Implementations

impl PaginationParams

pub const DEFAULT_LIMIT: u32 = 50

Default page size.

pub const MAX_LIMIT: u32 = 200

Maximum allowed page size.

pub fn resolved_limit(&self) -> u32

Resolved limit with bounds checking.

pub fn resolved_offset(&self) -> u32

Resolved offset.

Trait Implementations

impl Clone for PaginationParams

fn clone(&self) -> PaginationParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaginationParams

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

Formats the value using the given formatter.

impl Default for PaginationParams

fn default() -> PaginationParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PaginationParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoParams for PaginationParams

fn into_params( parameter_in_provider: impl Fn() -> Option<ParameterIn>, ) -> Vec<Parameter>

Provide Vec of openapi::path::Parameters to caller. The result is used in utoipa-gen library to provide OpenAPI parameter information for the endpoint using the parameters.

impl Serialize for PaginationParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.