edgar-rs 0.1.0

Rust client for the SEC EDGAR API
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use std::fmt;

use serde::{Deserialize, Serialize};

/// A Central Index Key (CIK) number identifying a company in SEC EDGAR.
///
/// CIK numbers are zero-padded to 10 digits in SEC URLs (e.g., `CIK0000320193`).
/// This type handles formatting automatically.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(transparent)]
pub struct Cik(u64);

impl Cik {
    /// Creates a new CIK from a numeric value.
    pub fn new(value: u64) -> Self {
        Self(value)
    }

    /// Returns the raw numeric value.
    pub fn as_u64(self) -> u64 {
        self.0
    }

    /// Formats the CIK as a zero-padded 10-digit string (e.g., `"0000320193"`).
    pub fn to_padded_string(self) -> String {
        format!("{:010}", self.0)
    }
}

impl fmt::Display for Cik {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl From<u64> for Cik {
    fn from(value: u64) -> Self {
        Self(value)
    }
}

impl From<u32> for Cik {
    fn from(value: u32) -> Self {
        Self(value as u64)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn new_and_as_u64() {
        let cik = Cik::new(320193);
        assert_eq!(cik.as_u64(), 320193);
    }

    #[test]
    fn to_padded_string_normal() {
        assert_eq!(Cik::new(320193).to_padded_string(), "0000320193");
    }

    #[test]
    fn to_padded_string_small() {
        assert_eq!(Cik::new(1).to_padded_string(), "0000000001");
    }

    #[test]
    fn to_padded_string_large() {
        assert_eq!(Cik::new(1234567890).to_padded_string(), "1234567890");
    }

    #[test]
    fn to_padded_string_zero() {
        assert_eq!(Cik::new(0).to_padded_string(), "0000000000");
    }

    #[test]
    fn display_shows_raw_number() {
        assert_eq!(format!("{}", Cik::new(320193)), "320193");
        assert_eq!(format!("{}", Cik::new(0)), "0");
    }

    #[test]
    fn from_u64() {
        let cik: Cik = 320193_u64.into();
        assert_eq!(cik.as_u64(), 320193);
    }

    #[test]
    fn from_u32() {
        let cik: Cik = 320193_u32.into();
        assert_eq!(cik.as_u64(), 320193);
    }

    #[test]
    fn equality() {
        assert_eq!(Cik::new(100), Cik::new(100));
        assert_ne!(Cik::new(100), Cik::new(200));
    }

    #[test]
    fn hash_consistent() {
        use std::collections::HashSet;
        let mut set = HashSet::new();
        set.insert(Cik::new(320193));
        assert!(set.contains(&Cik::new(320193)));
        assert!(!set.contains(&Cik::new(1)));
    }

    #[test]
    fn clone_and_copy() {
        let a = Cik::new(42);
        let b = a; // Copy
        let c = a; // Also Copy
        assert_eq!(a, b);
        assert_eq!(a, c);
    }

    #[test]
    fn serde_roundtrip() {
        let cik = Cik::new(320193);
        let json = serde_json::to_string(&cik).unwrap();
        assert_eq!(json, "320193");
        let deserialized: Cik = serde_json::from_str(&json).unwrap();
        assert_eq!(deserialized, cik);
    }

    #[test]
    fn serde_transparent_in_struct() {
        #[derive(serde::Serialize, serde::Deserialize, PartialEq, Debug)]
        struct Wrapper {
            cik: Cik,
        }
        let w = Wrapper {
            cik: Cik::new(320193),
        };
        let json = serde_json::to_string(&w).unwrap();
        assert_eq!(json, r#"{"cik":320193}"#);
        let back: Wrapper = serde_json::from_str(&json).unwrap();
        assert_eq!(back, w);
    }
}