Struct PaginationPolicy 

pub struct PaginationPolicy { /* private fields */ }

Deployment or namespace policy for paginated endpoints.

Implementations

impl PaginationPolicy

pub fn new( default_limit: NonZeroU32, max_limit: NonZeroU32, ) -> Result<Self, PaginationPolicyError>

Creates a policy, requiring the default to be no larger than the max.

pub fn from_values( default_limit: u32, max_limit: u32, ) -> Result<Self, PaginationPolicyError>

Creates a policy from raw integers.

pub fn default_limit(self) -> NonZeroU32

Returns the page size applied when callers omit limit.

pub fn max_limit(self) -> NonZeroU32

Returns the largest accepted caller-supplied limit.

pub fn resolve_limit( self, requested: Option<u32>, ) -> Result<EffectiveLimit, LimitError>

Resolves a caller-supplied limit into the enforced page size.

pub fn capability_limits(self) -> BTreeMap<String, u64>

Returns the advisory capability-document limits for this policy.

Trait Implementations

impl Clone for PaginationPolicy

fn clone(&self) -> PaginationPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PaginationPolicy

impl Debug for PaginationPolicy

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

Formats the value using the given formatter.

impl Default for PaginationPolicy

fn default() -> Self

Returns the “default value” for a type.

impl Eq for PaginationPolicy

impl PartialEq for PaginationPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PaginationPolicy