third_party/rust/serde_path_to_error/README.md

   1 # Serde path to error
   2
   3 [<img alt="github" src="https://img.shields.io/badge/github-dtolnay/path--to--error-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/dtolnay/path-to-error)
   4 [<img alt="crates.io" src="https://img.shields.io/crates/v/serde_path_to_error.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/serde_path_to_error)
   5 [<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-serde__path__to__error-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/serde_path_to_error)
   6 [<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/dtolnay/path-to-error/ci.yml?branch=master&style=for-the-badge" height="20">](https://github.com/dtolnay/path-to-error/actions?query=branch%3Amaster)
   7
   8 Find out the path at which a deserialization error occurred. This crate provides
   9 a wrapper that works with any existing Serde `Deserializer` and exposes the
  10 chain of field names leading to the error.
  11
  12 ```toml
  13 [dependencies]
  14 serde = "1.0"
  15 serde_path_to_error = "0.1"
  16 ```
  17
  18 ```rust
  19 use serde::Deserialize;
  20 use std::collections::BTreeMap as Map;
  21
  22 #[derive(Deserialize)]
  23 struct Package {
  24     name: String,
  25     dependencies: Map<String, Dependency>,
  26 }
  27
  28 #[derive(Deserialize)]
  29 struct Dependency {
  30     version: String,
  31 }
  32
  33 fn main() {
  34     let j = r#"{
  35         "name": "demo",
  36         "dependencies": {
  37             "serde": {
  38                 "version": 1
  39             }
  40         }
  41     }"#;
  42
  43     // Some Deserializer.
  44     let jd = &mut serde_json::Deserializer::from_str(j);
  45
  46     let result: Result<Package, _> = serde_path_to_error::deserialize(jd);
  47     match result {
  48         Ok(_) => panic!("expected a type error"),
  49         Err(err) => {
  50             let path = err.path().to_string();
  51             assert_eq!(path, "dependencies.serde.version");
  52         }
  53     }
  54 }
  55 ```
  56
  57 <br>
  58
  59 #### License
  60
  61 <sup>
  62 Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
  63 2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
  64 </sup>
  65
  66 <br>
  67
  68 <sub>
  69 Unless you explicitly state otherwise, any contribution intentionally submitted
  70 for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
  71 be dual licensed as above, without any additional terms or conditions.
  72 </sub>