finance-query 2.5.0

A Rust library for querying financial data
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

use super::SimilarSymbol;
/// Recommendation aggregate module
///
/// Contains the fully typed Recommendation structure for similar/recommended symbols.
use serde::{Deserialize, Serialize};

/// Fully typed recommendation data
///
/// Aggregates the queried symbol and its recommendations into a single
/// convenient structure. This is the recommended type for serialization
/// and API responses.
///
/// Note: This struct cannot be manually constructed - use `Ticker::recommendations()` to obtain recommendations.
#[non_exhaustive]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Recommendation {
    /// Symbol that was queried
    pub symbol: String,

    /// Recommended/similar symbols with scores
    pub recommendations: Vec<SimilarSymbol>,
}

impl Recommendation {
    /// Get just the symbol strings
    pub fn symbols(&self) -> Vec<&str> {
        self.recommendations
            .iter()
            .map(|s| s.symbol.as_str())
            .collect()
    }

    /// Get the number of recommendations
    pub fn count(&self) -> usize {
        self.recommendations.len()
    }
}

#[cfg(feature = "dataframe")]
impl Recommendation {
    /// Converts the recommendations to a polars DataFrame.
    pub fn to_dataframe(&self) -> ::polars::prelude::PolarsResult<::polars::prelude::DataFrame> {
        SimilarSymbol::vec_to_dataframe(&self.recommendations)
    }
}