Struct CursorPaginationParams 

pub struct CursorPaginationParams {
    pub limit: Option<u64>,
    pub after: Option<String>,
}

Query parameters for cursor-based list endpoints.

limit must be between 1 and 100 (inclusive) and defaults to 20. after is an opaque cursor token; omit it (or pass None) for the first page.

Requires std or alloc (after field contains String).

Fields

limit: Option<u64>

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

after: Option<String>

Opaque cursor for the next page. None requests the first page.

Implementations

impl CursorPaginationParams

pub fn new( limit: u64, after: Option<String>, ) -> Result<CursorPaginationParams, ValidationError>

Create validated cursor pagination params.

Returns Err if limit is outside 1–100.

Examples

use api_bones::pagination::CursorPaginationParams;

let p = CursorPaginationParams::new(50, None).unwrap();
assert_eq!(p.limit(), 50);

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

pub fn limit(&self) -> u64

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

Examples

use api_bones::pagination::CursorPaginationParams;

let p = CursorPaginationParams::default();
assert_eq!(p.limit(), 20);

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

pub fn after(&self) -> Option<&str>

The cursor token, if any.

Trait Implementations

impl Clone for CursorPaginationParams

fn clone(&self) -> CursorPaginationParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CursorPaginationParams

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

Formats the value using the given formatter.

impl Default for CursorPaginationParams

Available on crate features std or alloc only.

fn default() -> CursorPaginationParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CursorPaginationParams

fn deserialize<__D>( __deserializer: __D, ) -> Result<CursorPaginationParams, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S> FromRequestParts<S> for CursorPaginationParams

where S: Send + Sync,

type Rejection = ApiError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<CursorPaginationParams, <CursorPaginationParams as FromRequestParts<S>>::Rejection>

Perform the extraction.

impl PartialEq for CursorPaginationParams

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for CursorPaginationParams

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

impl<'v_a> ValidateArgs<'v_a> for CursorPaginationParams

type Args = ()

fn validate_with_args( &self, args: <CursorPaginationParams as ValidateArgs<'v_a>>::Args, ) -> Result<(), ValidationErrors>

impl Eq for CursorPaginationParams

impl StructuralPartialEq for CursorPaginationParams