Struct DividendAnalytics 

#[non_exhaustive]
pub struct DividendAnalytics {
    pub total_paid: f64,
    pub payment_count: usize,
    pub average_payment: f64,
    pub cagr: Option<f64>,
    pub last_payment: Option<Dividend>,
    pub first_payment: Option<Dividend>,
}

Computed analytics derived from a symbol’s dividend history.

Obtain via Ticker::dividend_analytics.

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.

total_paid: f64

Total dividends paid in the requested range

payment_count: usize

Number of dividend payments in the requested range

average_payment: f64

Average dividend per payment

cagr: Option<f64>

Compound Annual Growth Rate of the dividend amount.

None when fewer than two payments spanning at least one year are available.

last_payment: Option<Dividend>

Most recent dividend payment

first_payment: Option<Dividend>

Earliest dividend payment in the requested range

Trait Implementations

impl Clone for DividendAnalytics

fn clone(&self) -> DividendAnalytics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DividendAnalytics

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DividendAnalytics

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DividendAnalytics

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

where __S: Serializer,

Serialize this value into the given Serde serializer.