Skip to main content

ListProtestsOptions

Struct ListProtestsOptions 

Source
#[non_exhaustive]
pub struct ListProtestsOptions {
Show 19 fields pub page: Option<u32>, pub limit: Option<u32>, pub cursor: Option<String>, pub shape: Option<String>, pub flat: bool, pub flat_lists: bool, pub source_system: Option<String>, pub outcome: Option<String>, pub case_type: Option<String>, pub agency: Option<String>, pub case_number: Option<String>, pub solicitation_number: Option<String>, pub protester: Option<String>, pub search: Option<String>, pub filed_date_after: Option<String>, pub filed_date_before: Option<String>, pub decision_date_after: Option<String>, pub decision_date_before: Option<String>, pub extra: BTreeMap<String, String>,
}
Expand description

Options for Client::list_protests and Client::iterate_protests.

Mirrors the Go SDK’s ListProtestsOptions. The protests viewset does not accept server-side ordering — passing it returns 400 — so there’s no ordering field. The _after / _before date suffixes mirror the Python SDK’s naming.

Fields (Non-exhaustive)§

This struct is marked as 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.

§limit: Option<u32>

Page size (server caps at 100).

§cursor: Option<String>

Keyset cursor.

§shape: Option<String>

Comma-separated field selector. Use SHAPE_PROTESTS_MINIMAL 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.

§source_system: Option<String>

Source system filter ("GAO" or "COFC").

§outcome: Option<String>

Outcome label ("sustained", "denied", …).

§case_type: Option<String>

Case type filter.

§agency: Option<String>

Agency filter (CGAC code or name, depending on source system).

§case_number: Option<String>

Source-system case number filter.

§solicitation_number: Option<String>

Solicitation number filter.

§protester: Option<String>

Protester name filter.

§search: Option<String>

Free-text search filter.

§filed_date_after: Option<String>

Lower bound on filed_date (ISO YYYY-MM-DD, inclusive).

§filed_date_before: Option<String>

Upper bound on filed_date (inclusive).

§decision_date_after: Option<String>

Lower bound on decision_date (inclusive).

§decision_date_before: Option<String>

Upper bound on decision_date (inclusive).

§extra: BTreeMap<String, String>

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

Implementations§

Source§

impl ListProtestsOptions

Source

pub fn builder() -> ListProtestsOptionsBuilder

Create an instance of ListProtestsOptions using the builder syntax

Trait Implementations§

Source§

impl Clone for ListProtestsOptions

Source§

fn clone(&self) -> ListProtestsOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ListProtestsOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ListProtestsOptions

Source§

fn default() -> ListProtestsOptions

Returns the “default value” for a type. Read more
Source§

impl PartialEq for ListProtestsOptions

Source§

fn eq(&self, other: &ListProtestsOptions) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for ListProtestsOptions

Source§

impl StructuralPartialEq for ListProtestsOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more