Struct PaginationParams 

pub struct PaginationParams {
    pub limit: Option<u64>,
    pub offset: Option<u64>,
}

Query parameters for offset-based list endpoints.

limit must be between 1 and 100 (inclusive) and defaults to 20. offset defaults to 0.

When the validator feature is enabled (the default), calling .validate() enforces these constraints before the values are used.

Examples

use api_bones::pagination::PaginationParams;

let p = PaginationParams::default();
assert_eq!(p.limit(), 20);
assert_eq!(p.offset(), 0);

Fields

limit: Option<u64>

Maximum number of items to return (1–100). Defaults to 20.

offset: Option<u64>

Number of items to skip. Defaults to 0.

Implementations

impl PaginationParams

pub fn new(limit: u64, offset: u64) -> Result<Self, ValidationError>

Create validated pagination params.

Returns Err if limit is outside 1–100.

Examples

use api_bones::pagination::PaginationParams;

let p = PaginationParams::new(20, 0).unwrap();
assert_eq!(p.limit(), 20);
assert_eq!(p.offset(), 0);

assert!(PaginationParams::new(0, 0).is_err());
assert!(PaginationParams::new(101, 0).is_err());

impl PaginationParams

pub fn limit(&self) -> u64

Resolved limit value (falls back to the default of 20).

Examples

use api_bones::pagination::PaginationParams;

let p = PaginationParams { limit: None, offset: None };
assert_eq!(p.limit(), 20);

let p = PaginationParams { limit: Some(50), offset: None };
assert_eq!(p.limit(), 50);

pub fn offset(&self) -> u64

Resolved offset value (falls back to the default of 0).

Examples

use api_bones::pagination::PaginationParams;

let p = PaginationParams { limit: None, offset: None };
assert_eq!(p.offset(), 0);

let p = PaginationParams { limit: None, offset: Some(100) };
assert_eq!(p.offset(), 100);

Trait Implementations

impl Clone for PaginationParams

fn clone(&self) -> PaginationParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaginationParams

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

Formats the value using the given formatter.

impl Default for PaginationParams

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PaginationParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PaginationParams

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for PaginationParams

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for PaginationParams

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>

impl Eq for PaginationParams

impl StructuralPartialEq for PaginationParams