Struct LimitOffsetQuery 

pub struct LimitOffsetQuery {
    pub limit: Option<u64>,
    pub offset: Option<u64>,
}

Query parameters for limit/offset pagination.

Fields

limit: Option<u64>

Requested page size.

offset: Option<u64>

Requested offset from the beginning of the result set.

Implementations

impl LimitOffsetQuery

pub fn limit_or(&self, default: u64, max: u64) -> u64

Returns the requested limit clamped to [1, max], or default when absent.

pub fn offset(&self) -> u64

Returns the requested offset, or zero when absent.

Trait Implementations

impl Clone for LimitOffsetQuery

fn clone(&self) -> LimitOffsetQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for LimitOffsetQuery

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for LimitOffsetQuery

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

Formats the value using the given formatter.

impl Default for LimitOffsetQuery

fn default() -> LimitOffsetQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LimitOffsetQuery

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoParams for LimitOffsetQuery

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

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

impl ToSchema for LimitOffsetQuery

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.

impl Copy for LimitOffsetQuery