Struct EquityPerformance 

#[non_exhaustive]
pub struct EquityPerformance {
    pub max_age: Option<i64>,
    pub benchmark: Option<Benchmark>,
    pub performance_overview: Option<PerformanceOverview>,
    pub performance_overview_benchmark: Option<PerformanceOverview>,
}

Equity performance data comparing stock returns to benchmark

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.

max_age: Option<i64>

Maximum age of the data in seconds

benchmark: Option<Benchmark>

Benchmark information

performance_overview: Option<PerformanceOverview>

Stock performance overview across multiple time periods

performance_overview_benchmark: Option<PerformanceOverview>

Benchmark performance overview for comparison

Implementations

impl EquityPerformance

pub fn ytd_return(&self) -> Option<f64>

Returns the stock’s year-to-date return percentage

pub fn benchmark_ytd_return(&self) -> Option<f64>

Returns the benchmark’s year-to-date return percentage

pub fn ytd_vs_benchmark(&self) -> Option<f64>

Returns the stock’s outperformance vs benchmark for YTD (positive = outperforming)

pub fn one_year_return(&self) -> Option<f64>

Returns the stock’s 1-year total return percentage

pub fn benchmark_one_year_return(&self) -> Option<f64>

Returns the benchmark’s 1-year total return percentage

pub fn one_year_vs_benchmark(&self) -> Option<f64>

Returns the stock’s outperformance vs benchmark for 1 year (positive = outperforming)

pub fn five_year_return(&self) -> Option<f64>

Returns the stock’s 5-year total return percentage

pub fn benchmark_five_year_return(&self) -> Option<f64>

Returns the benchmark’s 5-year total return percentage

pub fn five_year_vs_benchmark(&self) -> Option<f64>

Returns the stock’s outperformance vs benchmark for 5 years (positive = outperforming)

pub fn benchmark_name(&self) -> Option<&str>

Returns the benchmark name

Trait Implementations

impl Clone for EquityPerformance

fn clone(&self) -> EquityPerformance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EquityPerformance

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

Formats the value using the given formatter.

impl Default for EquityPerformance

fn default() -> EquityPerformance

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EquityPerformance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EquityPerformance

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Translatable for EquityPerformance

fn visit_translatable(&mut self, visit: &mut dyn FnMut(&mut String))

Visit every translatable string field in a stable order.

fn after_translate(&mut self)

Hook invoked after translations have been written back, for types that maintain derived text (e.g. a transcript’s joined full text).