Skip to main content

jquants_api/models/
flex.rs

1use serde::{Deserialize, Deserializer, Serialize, Serializer};
2use serde_json::Value;
3use std::fmt;
4use std::ops::Deref;
5
6/// J-Quants API は同じ項目を string / number / null のいずれでも返すことがあるため、
7/// どれで来ても文字列として受け取る newtype。null は空文字列になる。
8#[derive(Debug, Clone, PartialEq, Default)]
9pub struct FlexString(pub String);
10
11impl FlexString {
12    /// 数値として解釈できれば `f64` を返す。null(空文字列)や非数値は `None`
13    pub fn as_f64(&self) -> Option<f64> {
14        self.0.parse().ok()
15    }
16
17    /// 値が空(API 応答が null または空文字列)かどうか
18    pub fn is_empty(&self) -> bool {
19        self.0.is_empty()
20    }
21}
22
23impl<'de> Deserialize<'de> for FlexString {
24    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
25        let value = Value::deserialize(deserializer)?;
26        let s = match value {
27            Value::String(s) => s,
28            Value::Number(n) => n.to_string(),
29            Value::Null => String::new(),
30            other => other.to_string(),
31        };
32        Ok(FlexString(s))
33    }
34}
35
36/// `null` を既定値として受ける。`#[serde(default)]` は「項目が無い」場合しか効かず、
37/// 明示的な `null` では失敗するため、配列項目にはこちらを使う。
38/// EDINET の応答は同じ項目を配列でも null でも返してくる
39pub fn null_as_default<'de, D, T>(deserializer: D) -> Result<T, D::Error>
40where
41    D: Deserializer<'de>,
42    T: Deserialize<'de> + Default,
43{
44    Ok(Option::<T>::deserialize(deserializer)?.unwrap_or_default())
45}
46
47impl Serialize for FlexString {
48    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
49        serializer.serialize_str(&self.0)
50    }
51}
52
53impl fmt::Display for FlexString {
54    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
55        f.write_str(&self.0)
56    }
57}
58
59impl Deref for FlexString {
60    type Target = str;
61    fn deref(&self) -> &str {
62        &self.0
63    }
64}
65
66#[cfg(test)]
67mod tests {
68    use super::*;
69
70    #[test]
71    fn deserializes_string_number_null() {
72        let v: Vec<FlexString> = serde_json::from_str(r#"["123.5", 42, null]"#).unwrap();
73        assert_eq!(v[0].0, "123.5");
74        assert_eq!(v[1].0, "42");
75        assert_eq!(v[2].0, "");
76    }
77
78    #[test]
79    fn null_becomes_empty_vec() {
80        #[derive(Deserialize)]
81        struct T {
82            #[serde(default, deserialize_with = "null_as_default")]
83            xs: Vec<i32>,
84        }
85        // 項目が無い場合も、明示的な null の場合も空になる
86        assert!(serde_json::from_str::<T>(r#"{}"#).unwrap().xs.is_empty());
87        assert!(serde_json::from_str::<T>(r#"{"xs":null}"#)
88            .unwrap()
89            .xs
90            .is_empty());
91        assert_eq!(
92            serde_json::from_str::<T>(r#"{"xs":[1,2]}"#).unwrap().xs,
93            vec![1, 2]
94        );
95    }
96
97    #[test]
98    fn as_f64_parses_numeric_only() {
99        assert_eq!(FlexString("123.5".into()).as_f64(), Some(123.5));
100        assert_eq!(FlexString(String::new()).as_f64(), None);
101        assert_eq!(FlexString("-".into()).as_f64(), None);
102    }
103}