Struct LookupResults 

#[non_exhaustive]
pub struct LookupResults {
    pub quotes: Vec<LookupQuote>,
    pub start: Option<i32>,
    pub count: Option<i32>,
}

Response wrapper for lookup endpoint

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.

quotes: Vec<LookupQuote>

Quote/document results

start: Option<i32>

Starting index

count: Option<i32>

Total result count

Implementations

impl LookupResults

pub fn from_json(value: Value) -> Result<Self, Error>

Parse LookupResults from raw JSON value

Example

let json = serde_json::json!({
    "finance": {
        "result": [{
            "documents": [],
            "start": 0,
            "count": 0
        }]
    }
});
let results = LookupResults::from_json(json)?;

pub fn quotes(&self) -> &[LookupQuote]

Get all quote results

pub fn result_count(&self) -> i32

Get total result count

pub fn is_empty(&self) -> bool

Check if any results were found

impl LookupResults

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

Converts the quotes to a polars DataFrame.

Trait Implementations

impl Clone for LookupResults

fn clone(&self) -> LookupResults

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LookupResults

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LookupResults

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LookupResults

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

where __S: Serializer,

Serialize this value into the given Serde serializer.