Struct IdvSubresourceOptions 

#[non_exhaustive]
pub struct IdvSubresourceOptions {
    pub page: Option<u32>,
    pub limit: Option<u32>,
    pub cursor: Option<String>,
    pub shape: Option<String>,
    pub flat: bool,
    pub flat_lists: bool,
    pub joiner: Option<String>,
    pub ordering: Option<String>,
    pub search: Option<String>,
    pub extra: BTreeMap<String, String>,
}

Options shared by every IDV sub-resource list endpoint (/api/idvs/{key}/awards/, /child-idvs/, /transactions/, /summary/awards/, /lcats/).

Carries pagination + shape + ordering + search + joiner. Use the extra field to forward filters not yet first-classed on this struct.

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. Mutually exclusive with cursor.

limit: Option<u32>

Page size.

cursor: Option<String>

Keyset cursor for cursor-paginated endpoints.

shape: Option<String>

Comma-separated field selector.

flat: bool

Collapse nested objects into dot-separated keys.

flat_lists: bool

When flat is also true, flatten list-valued fields.

joiner: Option<String>

Joiner for flattened keys (only sent when flat=true).

ordering: Option<String>

Server-side sort spec (prefix - for descending).

search: Option<String>

Free-text search filter.

extra: BTreeMap<String, String>

Escape hatch for filter keys not yet first-classed.

Implementations

impl IdvSubresourceOptions

pub fn builder() -> IdvSubresourceOptionsBuilder

Create an instance of IdvSubresourceOptions using the builder syntax

Trait Implementations

impl Clone for IdvSubresourceOptions

fn clone(&self) -> IdvSubresourceOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdvSubresourceOptions

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

Formats the value using the given formatter.

impl Default for IdvSubresourceOptions

fn default() -> IdvSubresourceOptions

Returns the “default value” for a type.

impl PartialEq for IdvSubresourceOptions

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

impl StructuralPartialEq for IdvSubresourceOptions