Struct df_st_api::api_objects::ApiPagination

pub struct ApiPagination { /* fields omitted */ }

A Query Guard for pagination of lists of items.

Trait Implementations

impl Clone for ApiPagination

fn clone(&self) -> ApiPagination

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiPagination

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

Formats the value using the given formatter.

impl Default for ApiPagination

fn default() -> ApiPagination

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for ApiPagination

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'q> FromQuery<'q> for ApiPagination

Parse incoming query data and store in ApiPagination

type Error = Error

The associated error to be returned if parsing/validation fails.

fn from_query(query: Query<'q>) -> Result<Self, Self::Error>

Parses and validates an instance of Self from a query or returns an Error if parsing or validation fails.

impl JsonSchema for ApiPagination

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<'r> OpenApiFromQuery<'r> for ApiPagination

Add support for OpenApi generator

fn query_multi_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Vec<Parameter>>

Return a RequestBody containing the information required to document the FromQuery for implementer.

impl Serialize for ApiPagination

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

Serialize this value into the given Serde serializer.