Struct CalendarEvent 

#[non_exhaustive]
pub struct CalendarEvent {
    pub id: String,
    pub kind: CalendarKind,
    pub time: DateTime<Utc>,
    pub country: String,
    pub title: String,
    pub symbol: Option<String>,
    pub importance: Option<Importance>,
    pub actual: Option<String>,
    pub forecast: Option<String>,
    pub prior: Option<String>,
}

One calendar event, its figures already formatted for display.

actual, forecast and prior are the reported figure, the consensus and the previous figure: the release for an economic event, the earnings per share for earnings, the amount per share for a dividend and the offer price for an IPO. Leave unknown figures None.

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.

id: String

Identifies the event among the events of one answer.

kind: CalendarKind

Calendar category, such as earnings or economic releases.

time: DateTime<Utc>

When the figure is released, the earnings reported, the dividend goes ex or the shares list.

country: String

The country, in the codes the feed uses, such as "US".

title: String

The release, such as "CPI (YoY)", or the company’s name.

symbol: Option<String>

The company’s symbol, for earnings, dividends and IPOs; the panel offers to open it.

importance: Option<Importance>

Importance assigned by the host, when applicable.

actual: Option<String>

Published figure, formatted by the host, when available.

forecast: Option<String>

Expected figure, formatted by the host, when available.

prior: Option<String>

Previous figure, formatted by the host, when available.

Implementations

impl CalendarEvent

pub fn new( id: impl Into<String>, kind: CalendarKind, time: DateTime<Utc>, title: impl Into<String>, ) -> Self

An event with a title and nothing else: set the other fields as known.

Trait Implementations

impl Clone for CalendarEvent

fn clone(&self) -> CalendarEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CalendarEvent

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

Formats the value using the given formatter.

impl PartialEq for CalendarEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CalendarEvent