divkit 0.0.2

US equity dividends and dividend yield for Rust, from SEC EDGAR public-domain XBRL. Companion to curvekit.
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

//! Unified error type for divkit. All public methods return `divkit::Result<T>`.
use thiserror::Error;

#[derive(Debug, Error)]
pub enum Error {
    #[error("http error: {0}")]
    Http(#[from] reqwest::Error),
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),
    #[error("parquet I/O error: {0}")]
    Parquet(String),
    #[error("arrow error: {0}")]
    Arrow(#[from] arrow::error::ArrowError),
    #[error("parquet error: {0}")]
    ParquetNative(#[from] parquet::errors::ParquetError),
    #[error("checksum mismatch for {file}: expected sha256:{expected} got sha256:{actual}")]
    ChecksumMismatch {
        file: String,
        expected: String,
        actual: String,
    },
    #[error("not found: {0}")]
    NotFound(String),
    #[error("build error: {0}")]
    Build(String),
    #[error("{0}")]
    Other(String),
}

pub type Result<T, E = Error> = std::result::Result<T, E>;

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn checksum_mismatch_displays_both_digests() {
        let e = Error::ChecksumMismatch {
            file: "dividends-2020.parquet".into(),
            expected: "aaa".into(),
            actual: "bbb".into(),
        };
        let s = e.to_string();
        assert!(s.contains("aaa") && s.contains("bbb") && s.contains("dividends-2020.parquet"));
    }
}