Enum EventKind 

#[non_exhaustive]
pub enum EventKind {
    Earnings {
        eps_estimate_low: Option<f64>,
        eps_estimate_avg: Option<f64>,
        eps_estimate_high: Option<f64>,
        revenue_estimate_avg: Option<i64>,
        is_estimate: bool,
    },
    ExDividend {
        amount: Option<f64>,
    },
    DividendPayment {
        amount: Option<f64>,
    },
    OptionsExpiration {
        contract_count: Option<usize>,
    },
    EconomicRelease {
        name: String,
        series_id: String,
    },
}

The kind of financial event, with its event-specific payload.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Earnings

Upcoming earnings report with analyst estimate data.

Fields

eps_estimate_low: Option<f64>

Low analyst EPS estimate for the quarter.

eps_estimate_avg: Option<f64>

Average analyst EPS estimate for the quarter.

eps_estimate_high: Option<f64>

High analyst EPS estimate for the quarter.

revenue_estimate_avg: Option<i64>

Average analyst revenue estimate for the quarter.

is_estimate: bool

Whether the date is an estimate (Yahoo flags upcoming dates as such).

ExDividend

Ex-dividend date — shares must be held before this date to receive the dividend.

Fields

amount: Option<f64>

Dividend amount per share, when known.

DividendPayment

Dividend payment date — cash arrives in the account.

Fields

amount: Option<f64>

Dividend amount per share, when known.

OptionsExpiration

Standard monthly options expiration (3rd Friday) for this ticker.

Only standard monthly expirations are surfaced — daily and weekly expirations are omitted to keep the calendar focused on the dates that carry meaningful open interest.

Fields

contract_count: Option<usize>

Number of listed contracts (calls + puts) expiring on this date when a chain was loaded. None if only the expiration date is known.

EconomicRelease

Economic data release (requires the fred feature).

Fields

name: String

Human-readable release name (e.g. “Consumer Price Index”).

series_id: String

FRED release identifier as a string.

Trait Implementations

impl Clone for EventKind

fn clone(&self) -> EventKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EventKind

fn eq(&self, other: &EventKind) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for EventKind

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EventKind