Struct Recommendation 

#[non_exhaustive]
pub struct Recommendation {
    pub symbol: String,
    pub recommendations: Vec<SimilarSymbol>,
}

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.

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.

symbol: String

Symbol that was queried

recommendations: Vec<SimilarSymbol>

Recommended/similar symbols with scores

Implementations

impl Recommendation

pub fn symbols(&self) -> Vec<&str>

Get just the symbol strings

pub fn count(&self) -> usize

Get the number of recommendations

impl Recommendation

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

Converts the recommendations to a polars DataFrame.

Trait Implementations

impl Clone for Recommendation

fn clone(&self) -> Recommendation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Recommendation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Recommendation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Recommendation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.