Struct OffsetConfiguration 

#[non_exhaustive]
pub struct OffsetConfiguration {
    pub offset_parameter: Option<ExtractedParameter>,
    pub limit_parameter: Option<ExtractedParameter>,
}

Offset-based pagination configuration that defines how to handle pagination using numeric offsets and limits.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

offset_parameter: Option<ExtractedParameter>

The parameter name used to specify the starting position or offset for retrieving results.

limit_parameter: Option<ExtractedParameter>

The parameter name used to specify the maximum number of results to return per page.

Implementations

impl OffsetConfiguration

pub fn offset_parameter(&self) -> Option<&ExtractedParameter>

The parameter name used to specify the starting position or offset for retrieving results.

pub fn limit_parameter(&self) -> Option<&ExtractedParameter>

The parameter name used to specify the maximum number of results to return per page.

impl OffsetConfiguration

pub fn builder() -> OffsetConfigurationBuilder

Creates a new builder-style object to manufacture OffsetConfiguration.

Trait Implementations

impl Clone for OffsetConfiguration

fn clone(&self) -> OffsetConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OffsetConfiguration

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

Formats the value using the given formatter.

impl PartialEq for OffsetConfiguration

fn eq(&self, other: &OffsetConfiguration) -> 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 StructuralPartialEq for OffsetConfiguration