Struct ListOptions 

#[non_exhaustive]
pub struct ListOptions {
    pub page: Option<u32>,
    pub limit: Option<u32>,
    pub cursor: Option<String>,
    pub shape: Option<String>,
    pub flat: bool,
    pub flat_lists: bool,
}

Pagination, shape, and flattening options common to every list endpoint.

Resource-specific option builders compose this via a pagination field. Constructing one directly is rarely useful; use the resource builder (e.g. ListContractsOptions::builder()) and call .page(...), .limit(...), .cursor(...), .shape(...), etc. on it.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

page: Option<u32>

1-based page number for offset-paginated endpoints. Mutually exclusive with cursor; when both are set, the cursor wins.

limit: Option<u32>

Page size. The server caps this at 100 on most endpoints.

cursor: Option<String>

Keyset cursor for cursor-paginated endpoints. Pass the cursor field from the previous Page.

shape: Option<String>

Comma-separated field selector for dynamic response shaping. Use one of the SHAPE_* constants or roll your own.

flat: bool

When true, collapse nested objects into dot-separated keys.

flat_lists: bool

When true (and flat is also true), flatten list-valued nested fields as well.

Implementations

impl ListOptions

pub fn builder() -> ListOptionsBuilder

Create an instance of ListOptions using the builder syntax

Trait Implementations

impl Clone for ListOptions

fn clone(&self) -> ListOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListOptions

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

Formats the value using the given formatter.

impl Default for ListOptions

fn default() -> ListOptions

Returns the “default value” for a type.

impl PartialEq for ListOptions

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

impl StructuralPartialEq for ListOptions