Struct EdgarSearchResults 

#[non_exhaustive]
pub struct EdgarSearchResults {
    pub query: Option<Value>,
    pub hits: Option<EdgarSearchHitsContainer>,
}

Full-text search results from SEC EDGAR.

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.

query: Option<Value>

The search query that was executed (Elasticsearch query DSL, stored as raw JSON)

hits: Option<EdgarSearchHitsContainer>

Nested hits container

Implementations

impl EdgarSearchResults

pub fn to_dataframe(&self) -> PolarsResult<DataFrame>

Convert search results to a polars DataFrame.

Extracts the _source data from each hit and converts to a DataFrame.

Example

let results = edgar::search("revenue", Some(&["10-K"]), None, None, None, Some(100)).await?;
let df = results.to_dataframe()?;
println!("Search results DataFrame: {:?}", df);

Trait Implementations

impl Clone for EdgarSearchResults

fn clone(&self) -> EdgarSearchResults

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EdgarSearchResults

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EdgarSearchResults

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EdgarSearchResults

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.