#serde

serde_ignored

Find out about keys that are ignored when deserializing data

7 releases

0.1.2 Jun 16, 2020
0.1.1 Dec 5, 2019
0.1.0 Aug 18, 2019
0.0.4 May 21, 2017
0.0.2 Feb 10, 2017

#279 in Encoding

Download history 18335/week @ 2021-08-11 18892/week @ 2021-08-18 19288/week @ 2021-08-25 17404/week @ 2021-09-01 22236/week @ 2021-09-08 21673/week @ 2021-09-15 19220/week @ 2021-09-22 22146/week @ 2021-09-29 29794/week @ 2021-10-06 21284/week @ 2021-10-13 22053/week @ 2021-10-20 20554/week @ 2021-10-27 22300/week @ 2021-11-03 23462/week @ 2021-11-10 23706/week @ 2021-11-17 21296/week @ 2021-11-24

94,819 downloads per month
Used in 141 crates (36 directly)

MIT/Apache

41KB
1K SLoC

Serde ignored

github crates.io docs.rs build status

Find out about keys that are ignored when deserializing data. This crate provides a wrapper that works with any existing Serde Deserializer and invokes a callback on every ignored field.

You can use this to warn users about extraneous keys in a config file, for example.

Note that if you want unrecognized fields to be an error, consider using the #[serde(deny_unknown_fields)] attribute instead.

[dependencies]
serde = "1.0"
serde_ignored = "0.1"
use serde::Deserialize;
use std::collections::{BTreeSet as Set, BTreeMap as Map};

#[derive(Debug, PartialEq, Deserialize)]
struct Package {
    name: String,
    dependencies: Map<String, Dependency>,
}

#[derive(Debug, PartialEq, Deserialize)]
struct Dependency {
    version: String,
}

fn main() {
    let j = r#"{
        "name": "demo",
        "dependencies": {
            "serde": {
                "version": "1.0",
                "typo1": ""
            }
        },
        "typo2": {
            "inner": ""
        },
        "typo3": {}
    }"#;

    // Some Deserializer.
    let jd = &mut serde_json::Deserializer::from_str(j);

    // We will build a set of paths to the unused elements.
    let mut unused = Set::new();

    let p: Package = serde_ignored::deserialize(jd, |path| {
        unused.insert(path.to_string());
    }).unwrap();

    // Deserialized as normal.
    println!("{:?}", p);

    // There were three ignored keys.
    let mut expected = Set::new();
    expected.insert("dependencies.serde.typo1".to_owned());
    expected.insert("typo2".to_owned());
    expected.insert("typo3".to_owned());
    assert_eq!(unused, expected);
}

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~140–260KB