yfinance-rs 0.9.1

Ergonomic Rust client for Yahoo Finance, supporting historical prices, real-time streaming, options, fundamentals, and more.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

use std::fmt;

/// Currency purpose used by diagnostics.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum YfCurrencyPurpose {
    /// Trading currency for quoted prices.
    Trading,
    /// Reporting currency for statements and ownership totals.
    Reporting,
    /// Currency for dividends and capital gains.
    CorporateAction,
    /// Currency for analyst estimates and price targets.
    AnalystEstimate,
}

impl fmt::Display for YfCurrencyPurpose {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let value = match self {
            Self::Trading => "trading",
            Self::Reporting => "reporting",
            Self::CorporateAction => "corporate-action",
            Self::AnalystEstimate => "analyst-estimate",
        };
        f.write_str(value)
    }
}

/// Heuristic used to infer a currency when Yahoo did not provide a usable currency field.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum YfCurrencyInference {
    /// Currency inferred from Yahoo symbol/listing or exchange metadata.
    ListingHeuristic,
    /// Currency inferred from a profile country mapping.
    ProfileCountryHeuristic,
}

impl fmt::Display for YfCurrencyInference {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let value = match self {
            Self::ListingHeuristic => "listing heuristic",
            Self::ProfileCountryHeuristic => "profile-country heuristic",
        };
        f.write_str(value)
    }
}

impl From<crate::core::currency_resolver::CurrencyPurpose> for YfCurrencyPurpose {
    fn from(value: crate::core::currency_resolver::CurrencyPurpose) -> Self {
        match value {
            crate::core::currency_resolver::CurrencyPurpose::Trading => Self::Trading,
            crate::core::currency_resolver::CurrencyPurpose::Reporting => Self::Reporting,
            crate::core::currency_resolver::CurrencyPurpose::CorporateAction => {
                Self::CorporateAction
            }
            crate::core::currency_resolver::CurrencyPurpose::AnalystEstimate => {
                Self::AnalystEstimate
            }
        }
    }
}

impl From<crate::core::currency_resolver::CurrencyInference> for YfCurrencyInference {
    fn from(value: crate::core::currency_resolver::CurrencyInference) -> Self {
        match value {
            crate::core::currency_resolver::CurrencyInference::ListingHeuristic => {
                Self::ListingHeuristic
            }
            crate::core::currency_resolver::CurrencyInference::ProfileCountryHeuristic => {
                Self::ProfileCountryHeuristic
            }
        }
    }
}