serdeでYYYY-MM-DD形式のJSON文字列をNaiveDateにデシリアライズしたい

Question

やりたいこと

YYYY-MM-DD 形式のjson文字列をNaiveDateに変換したい

let json_str = r#"
{
  "id": 1,
  "date": "2021-03-15"
}"#;

↓

#[derive(Serialize, Deserialize, Debug)]
struct Record {
    id: i32,
    #[serde(with="yyyy_mm_dd_fmt")]
    date: NaiveDate,
}

現状のコード全体

mod yyyy_mm_dd_fmt {
    use chrono::{NaiveDate};
    use serde::{self, Deserialize, Serializer, Deserializer};
    const FORMAT: &'static str = "%Y-%m-%d";

    pub fn serialize<S>(date: &NaiveDate, serializer: S) -> Result<S::Ok, S::Error>
    where S: Serializer,
    {
        let s = format!("{}", date.format(FORMAT));
        serializer.serialize_str(&s)
    }

    pub fn deserialize<'de, D>(deserializer: D) -> Result<NaiveDate, D::Error>
    where D: Deserializer<'de>,
    {
        let s = String::deserialize(deserializer)?;
        let nd = NaiveDate::parse_from_str(&s, FORMAT);
        nd
    }
}

use serde::{Serialize, Deserialize};
use chrono::NaiveDate;

#[derive(Serialize, Deserialize, Debug)]
struct Record {
    id: i32,
    #[serde(with="yyyy_mm_dd_fmt")]
    date: NaiveDate,
}

fn main() {
    let json_str = r#"
    {
      id:1,
      date:"2021-03-15",
    }"#;
    let record: Record = serde_json::from_str(json_str).unwrap();
    println!("{:?}", record)
}

きになっているところ

    pub fn deserialize<'de, D>(deserializer: D) -> Result<NaiveDate, D::Error>
    where D: Deserializer<'de>,
    {
        let s = String::deserialize(deserializer)?;
        let nd = NaiveDate::parse_from_str(&s, FORMAT);
        nd
    }

↑ 返り値の型が違うのでここでこのまま返せないのはわかっているんですが、matchなりmap_errを使ったあとに、
どうやって chrono::ParseError から Deserializer<'de> オブジェクトを作ればよいのでしょう?

cargo build の結果

   |
15 |     pub fn deserialize<'de, D>(deserializer: D) -> Result<NaiveDate, D::Error>
   |                                                    --------------------------- expected `std::result::Result<NaiveDate, <D as _::_serde::Deserializer<'de>>::Error>` because of return type
...
20 |         nd
   |         ^^ expected associated type, found struct `chrono::ParseError`
   |
   = note: expected enum `std::result::Result<_, <D as _::_serde::Deserializer<'de>>::Error>`
              found enum `std::result::Result<_, chrono::ParseError>`
help: consider constraining the associated type `<D as _::_serde::Deserializer<'de>>::Error` to `chrono::ParseError`
   |
16 |     where D: Deserializer<'de, Error = chrono::ParseError>,
   |                              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Answer 1

こんにちは。まず確認したいのですが環境は以下であっていますか

Rustのバージョン： 1.50.0
依存クレート

[dependencies]
serde = { version = "1.0.117", features = ["derive"]}
serde_json = "1.0.59"
chrono = { version = "0.4.19", features = ["serde"] }

この設定であれば NaiveDate でそのまま YYYY-MM-DD をデシリアライズできます。

use chrono::NaiveDate;
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Debug)]
struct Record {
    id: i32,
    date: NaiveDate,
}

fn main() {
    // JSONフォーマットにエラーがあったので修正した
    let json_str = r#"
    {
      "id":1,
      "date":"2021-03-15"
    }"#;
    let record: Record = serde_json::from_str(json_str).unwrap();
    println!("{:?}", record)
}

$ cargo run
    Finished dev [unoptimized + debuginfo] target(s) in 0.01s
     Running `target/debug/serde_chrono`
Record { id: 1, date: 2021-03-15 }

質問が「どうやって chrono::ParseError から Deserializer<'de> オブジェクトを作ればよいのでしょう」だったのでそれにもお答えします。

まず、作らないといけないのは Deserializer<'de> ではなく <D as _::_serde::Deserializer<'de>>::Error です。 <T as Trait>::Assoc という記法は見慣れないかもしれませんが、 T 型が実装している Trait における関連アイテムの Assoc を指す記法です。 つまりここでは Deserializer の関連型の Error を指しています。そこで Deserializer のドキュメントを見ると Error は de::Error トレイト を実装していることが分かります。なので de::Error にある関連関数を使って Error を作ることになります。実際のコードは以下のようになりました。

mod yyyy_mm_dd_fmt {
    use chrono::NaiveDate;
    // `de` をインポート
    use serde::{self, de, Deserialize, Deserializer, Serializer};
    const FORMAT: &'static str = "%Y-%m-%d";

    pub fn serialize<S>(date: &NaiveDate, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let s = format!("{}", date.format(FORMAT));
        serializer.serialize_str(&s)
    }

    pub fn deserialize<'de, D>(deserializer: D) -> Result<NaiveDate, D::Error>
    where
        D: Deserializer<'de>,
    {
        let s = String::deserialize(deserializer)?;
        NaiveDate::parse_from_str(&s, FORMAT)
            // `de::Error::custom` でエラー型の値を作る
            .map_err(|e| de::Error::custom(format!("chrono returned an error: {}", e)))
    }
}

こちらでも同様にデシリアライズできました。

$ cargo run
    Finished dev [unoptimized + debuginfo] target(s) in 0.01s
     Running `target/debug/serde_chrono`
Record { id: 1, date: 2021-03-15 }

以上で解決できるのではないかと思いますがどうでしょうか。分からない用語などありましたら遠慮なく質問下さい。

Comments

[blackenedgold]

`<T as Trait>::Assoc` という記法は公式ドキュメントの日本語訳では高度なトレイトという章で解説されています。
https://doc.rust-jp.rs/book-ja/ch19-03-advanced-traits.html#%E6%98%8E%E7%A2%BA%E5%8C%96%E3%81%AE%E3%81%9F%E3%82%81%E3%81%AE%E3%83%95%E3%83%AB%E3%83%91%E3%82%B9%E8%A8%98%E6%B3%95-%E5%90%8C%E3%81%98%E5%90%8D%E5%89%8D%E3%81%AE%E3%83%A1%E3%82%BD%E3%83%83%E3%83%89%E3%82%92%E5%91%BC%E3%81%B6

[tomlla_92]

非常に丁寧に解説いただきありがとうございました!

まずこの質問を試した際、chrono で `features = ["serde"]` を指定しておらず、
単純にこう書いていました。
```
chrono = "0.4"
```

features = ["serde"]` に変更して `#[serde(with="yyyy_mm_dd_fmt")]` を外すと問題なく動作しました。

ひとまずやりたいことは達成できました。
また実際に今後独自フォーマットのSerialize/Deserializeが必要になった際も提示していただいたサンプルコードのようにエラーハンドリングを行えばやりたい動作が実装できそうです。

ただし、今時点の私のRustへの理解レベルでは今後似たような問題にぶつかった際に

> そこで Deserializer のドキュメントを見ると Error は de::Error トレイト を実装していることが分かります。
> なので de::Error にある関連関数を使って Error を作ることになります。

という点をやコードやドキュメントから読み解けなさそうです。
この点はもうすこしRustのトレイト関連のドキュメント/書籍などを読んで理解してみようと思います。