Enum PaginationStyle 

pub enum PaginationStyle {
    None,
    Cursor {
        next_token_path: String,
        param_name: String,
    },
    LinkHeader,
    NextLinkInBody {
        next_link_path: String,
    },
    PageNumber {
        param_name: String,
        start_page: usize,
        page_size: Option<usize>,
        page_size_param: Option<String>,
    },
    Offset {
        offset_param: String,
        limit_param: String,
        limit: usize,
        total_path: Option<String>,
    },
}

Supported pagination strategies.

Variants

None

Cursor

Fields

next_token_path: String

param_name: String

LinkHeader

NextLinkInBody

The full URL of the next page is embedded in the response body. next_link_path is a JSONPath expression pointing to that URL field (e.g. "$.next_link"). Pagination stops when the field is absent, null, or an empty string.

Fields

next_link_path: String

PageNumber

Fields

param_name: String

start_page: usize

page_size: Option<usize>

page_size_param: Option<String>

Offset

Fields

offset_param: String

limit_param: String

limit: usize

total_path: Option<String>

Implementations

impl PaginationStyle

pub fn apply_params( &self, params: &mut HashMap<String, String>, state: &PaginationState, )

pub fn advance( &self, body: &Value, headers: &HeaderMap, state: &mut PaginationState, record_count: usize, ) -> Result<bool, FaucetError>

Advance pagination state based on the response body and headers. Returns true if there is a next page to fetch.

Includes loop detection: if a cursor or next-link value is identical to the previous page’s value, pagination stops with a warning instead of looping forever.

Trait Implementations

impl Clone for PaginationStyle

fn clone(&self) -> PaginationStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaginationStyle

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PaginationStyle

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PaginationStyle

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

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

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for PaginationStyle

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

where __S: Serializer,

Serialize this value into the given Serde serializer.