Skip to main content

Module page

Module page 

Expand description

Generic paginated-page envelope used by every list route. The shape mirrors what generated clients consume.

Structs§

CursorPage
Built-in cursor-paginated response (CursorPage<T> in .cstack, procedure-return only): the items plus the cursor for the next page, absent on the last page.
CursorPageInput
Built-in cursor (keyset) pagination input (CursorPageInput in .cstack), procedure-argument only — the keyset sibling of PageInput. cursor is the opaque token a previous CursorPage::next_cursor returned; absent (or empty) means “first page”. See docs/design/cursor-pagination.md.
Page
PageInfo
PageInput
Built-in pagination-input argument type (PageInput in .cstack), currently valid only as a procedure argument — the request-side mirror of Page/PageInfo on the response side. Field names and optionality match PageInfo’s own limit/offset exactly, so a generated list route and a hand-written PageInput-accepting procedure decode the same wire shape.

Constants§

MAX_LIST_LIMIT
Hard ceiling on the limit query parameter (REST) / RPC list-input field every generated list route accepts, regardless of whether the model is @@paged. Requests above this are rejected with a 400, the same way negative limit/offset already are — see handle_list_<plural>_dispatch in the generated code, shared byte-for-byte between REST and RPC dispatch.