vendor/serde_ignored/README.md

   1 # Serde ignored
   2
   3 [<img alt="github" src="https://img.shields.io/badge/github-dtolnay/serde--ignored-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/dtolnay/serde-ignored)
   4 [<img alt="crates.io" src="https://img.shields.io/crates/v/serde_ignored.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/serde_ignored)
   5 [<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-serde__ignored-66c2a5?style=for-the-badge&labelColor=555555&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K" height="20">](https://docs.rs/serde_ignored)
   6 [<img alt="build status" src="https://img.shields.io/github/workflow/status/dtolnay/serde-ignored/CI/master?style=for-the-badge" height="20">](https://github.com/dtolnay/serde-ignored/actions?query=branch%3Amaster)
   7
   8 Find out about keys that are ignored when deserializing data. This crate
   9 provides a wrapper that works with any existing Serde `Deserializer` and invokes
  10 a callback on every ignored field.
  11
  12 You can use this to warn users about extraneous keys in a config file, for
  13 example.
  14
  15 Note that if you want unrecognized fields to be an error, consider using the
  16 `#[serde(deny_unknown_fields)]` [attribute] instead.
  17
  18 [attribute]: https://serde.rs/attributes.html
  19
  20 ```toml
  21 [dependencies]
  22 serde = "1.0"
  23 serde_ignored = "0.1"
  24 ```
  25
  26 ```rust
  27 use serde::Deserialize;
  28 use std::collections::{BTreeSet as Set, BTreeMap as Map};
  29
  30 #[derive(Debug, PartialEq, Deserialize)]
  31 struct Package {
  32     name: String,
  33     dependencies: Map<String, Dependency>,
  34 }
  35
  36 #[derive(Debug, PartialEq, Deserialize)]
  37 struct Dependency {
  38     version: String,
  39 }
  40
  41 fn main() {
  42     let j = r#"{
  43         "name": "demo",
  44         "dependencies": {
  45             "serde": {
  46                 "version": "1.0",
  47                 "typo1": ""
  48             }
  49         },
  50         "typo2": {
  51             "inner": ""
  52         },
  53         "typo3": {}
  54     }"#;
  55
  56     // Some Deserializer.
  57     let jd = &mut serde_json::Deserializer::from_str(j);
  58
  59     // We will build a set of paths to the unused elements.
  60     let mut unused = Set::new();
  61
  62     let p: Package = serde_ignored::deserialize(jd, |path| {
  63         unused.insert(path.to_string());
  64     }).unwrap();
  65
  66     // Deserialized as normal.
  67     println!("{:?}", p);
  68
  69     // There were three ignored keys.
  70     let mut expected = Set::new();
  71     expected.insert("dependencies.serde.typo1".to_owned());
  72     expected.insert("typo2".to_owned());
  73     expected.insert("typo3".to_owned());
  74     assert_eq!(unused, expected);
  75 }
  76 ```
  77
  78 <br>
  79
  80 #### License
  81
  82 <sup>
  83 Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
  84 2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
  85 </sup>
  86
  87 <br>
  88
  89 <sub>
  90 Unless you explicitly state otherwise, any contribution intentionally submitted
  91 for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
  92 be dual licensed as above, without any additional terms or conditions.
  93 </sub>