#serde

serde_ignored

Find out about keys that are ignored when deserializing data

4 releases

0.0.4 May 21, 2017
0.0.3 Apr 27, 2017
0.0.2 Feb 10, 2017
0.0.1 Feb 9, 2017

#13 in Encoding

Download history 6624/week @ 2018-06-16 8161/week @ 2018-06-23 9817/week @ 2018-06-30 10123/week @ 2018-07-07 9815/week @ 2018-07-14 10313/week @ 2018-07-21 10484/week @ 2018-07-28 11146/week @ 2018-08-04 10837/week @ 2018-08-11 10424/week @ 2018-08-18 10319/week @ 2018-08-25 9256/week @ 2018-09-01 8611/week @ 2018-09-08

34,520 downloads per month
Used in 41 crates (5 directly)

MIT/Apache

36KB
862 lines

Serde ignored

Build Status Latest Version Rust Documentation

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.0.4"
#[macro_use]
extern crate serde_derive;

extern crate serde;
extern crate serde_json;
extern crate serde_ignored;

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": "0.9",
                "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

This crate is licensed under either of

at your option.

Contribution

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

~335KB