Struct ListFederalRegisterDocumentsOptions 

#[non_exhaustive]
pub struct ListFederalRegisterDocumentsOptions {

    pub page: Option<u32>,
    pub limit: Option<u32>,
    pub cursor: Option<String>,
    pub shape: Option<String>,
    pub flat: bool,
    pub flat_lists: bool,
    pub search: Option<String>,
    pub document_number: Option<String>,
    pub type: Option<String>,
    pub agency: Option<String>,
    pub fr_agency: Option<String>,
    pub publication_date_after: Option<String>,
    pub publication_date_before: Option<String>,
    pub effective_on_after: Option<String>,
    pub effective_on_before: Option<String>,
    pub comments_close_on_after: Option<String>,
    pub comments_close_on_before: Option<String>,
    pub comments_open: Option<bool>,
    pub cfr_title: Option<String>,
    pub cfr_part: Option<String>,
    pub significant: Option<bool>,
    pub rin: Option<String>,
    pub executive_order_number: Option<String>,
    pub ordering: Option<String>,
    pub extra: BTreeMap<String, String>,
}

Options for Client::list_federal_register_documents and Client::iterate_federal_register_documents.

All seventeen of the API’s filters are named fields, plus ordering.

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.

limit: Option<u32>

Page size (server caps at 100).

cursor: Option<String>

Keyset cursor.

shape: Option<String>

Comma-separated field selector. Use SHAPE_FEDERAL_REGISTER_MINIMAL or roll your own. full_text is not available on the list.

flat: bool

Collapse nested objects into dot-separated keys.

flat_lists: bool

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

search: Option<String>

Ranked full-text search over the title, abstract and action. Wrap in double quotes for a phrase.

document_number: Option<String>

Exact FR document number, e.g. 2016-31922. OR several with |. A number the Federal Register reused before 2016 matches every document that carries it.

type: Option<String>

Document type: Notice, Rule, Proposed Rule, Presidential Document, Correction, Sunshine Act Document or Uncategorized Document (case-insensitive). OR several with |. Documents published before 2008 are mostly Uncategorized Document.

agency: Option<String>

A Tango agency name, abbreviation, code or organization key, e.g. EPA. Matches a document when any agency it lists falls within that organization, so a department includes its sub-agencies. OR several with |.

fr_agency: Option<String>

The Federal Register’s own agency slug, e.g. environmental-protection-agency. OR several with |.

publication_date_after: Option<String>

Published on or after (YYYY-MM-DD).

publication_date_before: Option<String>

Published on or before (YYYY-MM-DD).

effective_on_after: Option<String>

Effective on or after (YYYY-MM-DD).

effective_on_before: Option<String>

Effective on or before (YYYY-MM-DD).

comments_close_on_after: Option<String>

Comment period closes on or after (YYYY-MM-DD).

comments_close_on_before: Option<String>

Comment period closes on or before (YYYY-MM-DD).

comments_open: Option<bool>

Some(true) for documents whose comment period closes today or later, Some(false) for those already closed. Documents with no comment deadline match neither.

cfr_title: Option<String>

A CFR title number, e.g. 40.

cfr_part: Option<String>

A CFR part number, e.g. 52. Requires cfr_title, and both must match the same CFR reference.

significant: Option<bool>

Significant under Executive Order 12866.

rin: Option<String>

A Regulation Identifier Number, e.g. 2060-AV16. OR several with |.

executive_order_number: Option<String>

Exact executive order number.

ordering: Option<String>

Sort key: publication_date (the server default, as -publication_date), effective_on, comments_close_on, document_number or rank, prefixed with - for descending. rank requires a non-empty search.

extra: BTreeMap<String, String>

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

Implementations

impl ListFederalRegisterDocumentsOptions

pub fn builder() -> ListFederalRegisterDocumentsOptionsBuilder

Create an instance of ListFederalRegisterDocumentsOptions using the builder syntax

Trait Implementations

impl Clone for ListFederalRegisterDocumentsOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListFederalRegisterDocumentsOptions

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

Formats the value using the given formatter.

impl Default for ListFederalRegisterDocumentsOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ListFederalRegisterDocumentsOptions

impl PartialEq for ListFederalRegisterDocumentsOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ListFederalRegisterDocumentsOptions