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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

use crate::core::{
    DataQuality,
    client::{CacheMode, RetryConfig},
};

/// Per-call behavior shared by builders and internal fetch helpers.
#[derive(Clone, Debug)]
pub struct CallOptions {
    pub(crate) cache_mode: CacheMode,
    retry_override: Option<RetryConfig>,
    pub(crate) data_quality: DataQuality,
}

impl CallOptions {
    pub(crate) const fn new() -> Self {
        Self {
            cache_mode: CacheMode::Default,
            retry_override: None,
            data_quality: DataQuality::BestEffort,
        }
    }

    pub(crate) const fn cache_mode(&self) -> CacheMode {
        self.cache_mode
    }

    pub(crate) const fn retry_override(&self) -> Option<&RetryConfig> {
        self.retry_override.as_ref()
    }

    pub(crate) const fn data_quality(&self) -> DataQuality {
        self.data_quality
    }

    pub(crate) const fn with_cache_mode(mut self, mode: CacheMode) -> Self {
        self.cache_mode = mode;
        self
    }

    pub(crate) fn with_retry_policy(mut self, cfg: Option<RetryConfig>) -> Self {
        self.retry_override = cfg;
        self
    }

    pub(crate) const fn with_data_quality(mut self, policy: DataQuality) -> Self {
        self.data_quality = policy;
        self
    }

    pub(crate) const fn strict(self) -> Self {
        self.with_data_quality(DataQuality::Strict)
    }
}

impl Default for CallOptions {
    fn default() -> Self {
        Self::new()
    }
}

macro_rules! impl_call_option_setters {
    () => {
        $crate::core::impl_call_option_setters!(
            strict_doc = "Fails when Yahoo data cannot be projected losslessly."
        );
    };
    (strict_doc = $strict_doc:literal) => {
        /// Sets the cache mode for this request.
        #[must_use]
        pub const fn cache_mode(mut self, mode: $crate::core::CacheMode) -> Self {
            self.options.cache_mode = mode;
            self
        }

        /// Overrides the retry policy for this request.
        #[must_use]
        pub fn retry_policy(mut self, cfg: Option<$crate::core::RetryConfig>) -> Self {
            self.options = self.options.with_retry_policy(cfg);
            self
        }

        /// Sets how provider projection issues are handled.
        #[must_use]
        pub const fn data_quality(mut self, policy: $crate::core::DataQuality) -> Self {
            self.options.data_quality = policy;
            self
        }

        #[doc = $strict_doc]
        #[must_use]
        pub const fn strict(self) -> Self {
            self.data_quality($crate::core::DataQuality::Strict)
        }
    };
}

pub(crate) use impl_call_option_setters;