Struct CalendarEvents 

#[non_exhaustive]
pub struct CalendarEvents {
    pub max_age: Option<i64>,
    pub earnings: Option<EarningsCalendar>,
    pub ex_dividend_date: Option<FormattedValue<i64>>,
    pub dividend_date: Option<FormattedValue<i64>>,
}

Calendar events including earnings and dividend dates

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

earnings: Option<EarningsCalendar>

Upcoming earnings date(s)

ex_dividend_date: Option<FormattedValue<i64>>

Ex-dividend date (Unix timestamp)

dividend_date: Option<FormattedValue<i64>>

Dividend date (Unix timestamp)

Implementations

impl CalendarEvents

pub fn next_earnings_date(&self) -> Option<i64>

Returns the next earnings date if available

pub fn ex_dividend_timestamp(&self) -> Option<i64>

Returns the ex-dividend date as Unix timestamp

pub fn dividend_timestamp(&self) -> Option<i64>

Returns the dividend date as Unix timestamp

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

Returns the earnings estimate average

Trait Implementations

impl Clone for CalendarEvents

fn clone(&self) -> CalendarEvents

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CalendarEvents

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

Formats the value using the given formatter.

impl Default for CalendarEvents

fn default() -> CalendarEvents

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CalendarEvents

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CalendarEvents

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 CalendarEvents

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).