Struct ListContractsOptions 

#[non_exhaustive]
pub struct ListContractsOptions {

    pub page: Option<u32>,
    pub limit: Option<u32>,
    pub cursor: Option<String>,
    pub shape: Option<String>,
    pub flat: bool,
    pub flat_lists: bool,
    pub award_date: Option<String>,
    pub award_date_gte: Option<String>,
    pub award_date_lte: Option<String>,
    pub award_type: Option<String>,
    pub fiscal_year: Option<String>,
    pub fiscal_year_gte: Option<String>,
    pub fiscal_year_lte: Option<String>,
    pub obligated_gte: Option<String>,
    pub obligated_lte: Option<String>,
    pub pop_start_date_gte: Option<String>,
    pub pop_start_date_lte: Option<String>,
    pub pop_end_date_gte: Option<String>,
    pub pop_end_date_lte: Option<String>,
    pub expiring_gte: Option<String>,
    pub expiring_lte: Option<String>,
    pub awarding_agency: Option<String>,
    pub funding_agency: Option<String>,
    pub piid: Option<String>,
    pub solicitation_identifier: Option<String>,
    pub naics: Option<String>,
    pub psc: Option<String>,
    pub recipient: Option<String>,
    pub uei: Option<String>,
    pub set_aside: Option<String>,
    pub naics_code: Option<String>,
    pub psc_code: Option<String>,
    pub recipient_name: Option<String>,
    pub recipient_uei: Option<String>,
    pub set_aside_type: Option<String>,
    pub search: Option<String>,
    pub keyword: Option<String>,
    pub ordering: Option<String>,
    pub sort: Option<String>,
    pub order: Option<String>,
    pub extra: BTreeMap<String, String>,
}

Options for Client::list_contracts and Client::iterate_contracts.

SDK-friendly aliases (naics_code, psc_code, recipient_name, recipient_uei, set_aside_type) map to the canonical API names — passing both prefers the SDK alias to mirror the Node and Python SDKs.

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 (server caps 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. Use a SHAPE_* constant or roll your own.

flat: bool

Collapse nested objects into dot-separated keys.

flat_lists: bool

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

award_date: Option<String>

Single-day award_date filter (ISO YYYY-MM-DD).

award_date_gte: Option<String>

Lower bound for award_date (inclusive).

award_date_lte: Option<String>

Upper bound for award_date (inclusive).

award_type: Option<String>

award_type filter (e.g. "BPA Call").

fiscal_year: Option<String>

fiscal_year filter (accepts "2024", "FY24", or range expressions).

fiscal_year_gte: Option<String>

Lower bound for fiscal_year.

fiscal_year_lte: Option<String>

Upper bound for fiscal_year.

obligated_gte: Option<String>

Lower bound for obligated (dollars).

obligated_lte: Option<String>

Upper bound for obligated (dollars).

pop_start_date_gte: Option<String>

Lower bound for period-of-performance start date.

pop_start_date_lte: Option<String>

Upper bound for period-of-performance start date.

pop_end_date_gte: Option<String>

Lower bound for period-of-performance end date.

pop_end_date_lte: Option<String>

Upper bound for period-of-performance end date.

expiring_gte: Option<String>

Lower bound for contract expiration date.

expiring_lte: Option<String>

Upper bound for contract expiration date.

awarding_agency: Option<String>

Awarding agency CGAC code (e.g. "9700").

funding_agency: Option<String>

Funding agency CGAC code.

piid: Option<String>

Procurement Instrument Identifier filter.

solicitation_identifier: Option<String>

Solicitation identifier filter.

naics: Option<String>

NAICS code (canonical name).

psc: Option<String>

PSC code (canonical name).

recipient: Option<String>

Recipient name filter (canonical name).

uei: Option<String>

Recipient UEI filter (canonical name).

set_aside: Option<String>

Set-aside filter (canonical name).

naics_code: Option<String>

SDK-friendly alias for naics.

psc_code: Option<String>

SDK-friendly alias for psc.

recipient_name: Option<String>

SDK-friendly alias for recipient.

recipient_uei: Option<String>

SDK-friendly alias for uei.

set_aside_type: Option<String>

SDK-friendly alias for set_aside.

search: Option<String>

Free-text search filter.

keyword: Option<String>

SDK-friendly alias for search.

ordering: Option<String>

Server-side sort spec (e.g. "obligated", prefix - for descending).

sort: Option<String>

Sort field — combined with order into ordering.

order: Option<String>

"asc" or "desc". Only meaningful when sort is set.

extra: BTreeMap<String, String>

Escape hatch for filter keys not yet first-classed on this struct.

Implementations

impl ListContractsOptions

pub fn builder() -> ListContractsOptionsBuilder

Create an instance of ListContractsOptions using the builder syntax

Trait Implementations

impl Clone for ListContractsOptions

fn clone(&self) -> ListContractsOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListContractsOptions

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

Formats the value using the given formatter.

impl Default for ListContractsOptions

fn default() -> ListContractsOptions

Returns the “default value” for a type.

impl PartialEq for ListContractsOptions

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

impl StructuralPartialEq for ListContractsOptions