Struct FilingSearchFilters 

#[non_exhaustive]
pub struct FilingSearchFilters {
    pub forms: Option<Vec<String>>,
    pub start_date: Option<String>,
    pub end_date: Option<String>,
    pub cik: Option<String>,
    pub limit: Option<u32>,
}

Which parts of a full-text search to constrain.

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.

forms: Option<Vec<String>>

Restrict to these form types (e.g. ["10-K", "8-K"]).

start_date: Option<String>

Earliest filing date, YYYY-MM-DD.

end_date: Option<String>

Latest filing date, YYYY-MM-DD.

cik: Option<String>

Restrict to a single filer’s CIK (zero-padded or not).

limit: Option<u32>

Maximum hits to return. Providers cap this; EDGAR’s ceiling is 100.

Implementations

impl FilingSearchFilters

pub fn forms<S: Into<String>, I: IntoIterator<Item = S>>(self, forms: I) -> Self

Restrict the search to these form types.

pub fn from(self, date: impl Into<String>) -> Self

Restrict the search to filings on or after date (YYYY-MM-DD).

pub fn to(self, date: impl Into<String>) -> Self

Restrict the search to filings on or before date (YYYY-MM-DD).

pub fn cik(self, cik: impl Into<String>) -> Self

Restrict the search to one filer.

pub fn limit(self, limit: u32) -> Self

Cap the number of hits returned.

Trait Implementations

impl Clone for FilingSearchFilters

fn clone(&self) -> FilingSearchFilters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilingSearchFilters

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

Formats the value using the given formatter.

impl Default for FilingSearchFilters

fn default() -> FilingSearchFilters

Returns the “default value” for a type.