Struct CursorParams 

pub struct CursorParams<const MAX: u64 = 100, const DEFAULT: u64 = 20> {
    pub after: Option<String>,
    pub before: Option<String>,
    pub limit: Option<u64>,
}

?after=TOKEN or ?before=TOKEN, and ?limit=N from 1 to MAX, DEFAULT when absent.

Without a token the first page is returned. Both tokens together, an out-of-range or non-numeric limit are rejected with 422 before the handler runs, and the documented query parameters state the bounds. Use it as Query<CursorParams> (at most 100, default 20) or choose the bounds: Query<CursorParams<500, 50>>.

Fields

after: Option<String>

The next cursor of the previous page: continue after it.

before: Option<String>

The previous cursor of a page: the page before it.

limit: Option<u64>

Items per page.

Implementations

impl<const MAX: u64, const DEFAULT: u64> CursorParams<MAX, DEFAULT>

pub fn limit(&self) -> u64

The requested page size, DEFAULT when absent.

pub async fn fetch<M: Model>( &self, queryset: QuerySet<M>, ) -> Result<CursorPage<M>, OrmError>

Fetch this page of queryset (one statement, no count).

Errors

OrmError::Cursor for a token the queryset rejects (answered with 400 by ApiError), capability or backend errors.

Trait Implementations

impl<const MAX: u64, const DEFAULT: u64> Clone for CursorParams<MAX, DEFAULT>

fn clone(&self) -> CursorParams<MAX, DEFAULT>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MAX: u64, const DEFAULT: u64> Debug for CursorParams<MAX, DEFAULT>

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

Formats the value using the given formatter.

impl<const MAX: u64, const DEFAULT: u64> Default for CursorParams<MAX, DEFAULT>

fn default() -> CursorParams<MAX, DEFAULT>

Returns the “default value” for a type.

impl<'de, const MAX: u64, const DEFAULT: u64> Deserialize<'de> for CursorParams<MAX, DEFAULT>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const MAX: u64, const DEFAULT: u64> Eq for CursorParams<MAX, DEFAULT>

impl<const MAX: u64, const DEFAULT: u64> PartialEq for CursorParams<MAX, DEFAULT>

fn eq(&self, other: &CursorParams<MAX, DEFAULT>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<const MAX: u64, const D: u64> Schema for CursorParams<MAX, D>

fn schema(_: &mut SchemaRegistry) -> SchemaObject

The schema definition of this type. Use SchemaRegistry::subschema for nested types.

fn schema_name() -> Option<&'static str>

Stable component name. Named types are emitted once under components.schemas and referenced with $ref.

impl<const MAX: u64, const DEFAULT: u64> StructuralPartialEq for CursorParams<MAX, DEFAULT>

impl<const MAX: u64, const D: u64> Validate for CursorParams<MAX, D>

fn prepare(input: &mut Value, ctx: &mut ValidationContext)

Check and normalise the raw input for this type in place.

fn validate(&self, _ctx: &mut ValidationContext)

Check invariants of the deserialized value.