Enum PaginationConfigDto 

pub enum PaginationConfigDto {
    OffsetLimit {
        offset_param: ConfigValue<String>,
        limit_param: ConfigValue<String>,
        page_size: ConfigValue<u64>,
        total_path: Option<ConfigValue<String>>,
    },
    PageNumber {
        page_param: ConfigValue<String>,
        page_size_param: ConfigValue<String>,
        page_size: ConfigValue<u64>,
        total_pages_path: Option<ConfigValue<String>>,
    },
    Cursor {
        cursor_param: ConfigValue<String>,
        cursor_path: ConfigValue<String>,
        has_more_path: Option<ConfigValue<String>>,
        page_size_param: Option<ConfigValue<String>>,
        page_size: Option<ConfigValue<u64>>,
    },
    LinkHeader {
        page_size_param: Option<ConfigValue<String>>,
        page_size: Option<ConfigValue<u64>>,
    },
    NextUrl {
        next_url_path: ConfigValue<String>,
        base_url: Option<ConfigValue<String>>,
    },
}

Pagination configuration DTO.

Variants

OffsetLimit

Offset/limit pagination.

Fields

offset_param: ConfigValue<String>

limit_param: ConfigValue<String>

page_size: ConfigValue<u64>

total_path: Option<ConfigValue<String>>

PageNumber

Page number pagination.

Fields

page_param: ConfigValue<String>

page_size_param: ConfigValue<String>

page_size: ConfigValue<u64>

total_pages_path: Option<ConfigValue<String>>

Cursor

Cursor-based pagination.

Fields

cursor_param: ConfigValue<String>

cursor_path: ConfigValue<String>

has_more_path: Option<ConfigValue<String>>

page_size_param: Option<ConfigValue<String>>

page_size: Option<ConfigValue<u64>>

LinkHeader

Link header pagination (RFC 5988).

Fields

page_size_param: Option<ConfigValue<String>>

page_size: Option<ConfigValue<u64>>

NextUrl

Next URL from response body.

Fields

next_url_path: ConfigValue<String>

base_url: Option<ConfigValue<String>>

Trait Implementations

impl Clone for PaginationConfigDto

fn clone(&self) -> PaginationConfigDto

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaginationConfigDto

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PaginationConfigDto

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PaginationConfigDto

fn eq(&self, other: &PaginationConfigDto) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PaginationConfigDto

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PaginationConfigDto

impl<'__s> ToSchema<'__s> for PaginationConfigDto

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.