#deserialize #serde #serde-derive #utilities #serde-default #no-alloc

no-std serde-bool

Single value, true or false, boolean deserializers

7 releases

0.1.3 Dec 1, 2023
0.1.2 Nov 30, 2023
0.0.3 Nov 30, 2023

#1166 in Encoding

Download history 348/week @ 2024-07-23 447/week @ 2024-07-30 402/week @ 2024-08-06 275/week @ 2024-08-13 324/week @ 2024-08-20 248/week @ 2024-08-27 253/week @ 2024-09-03 176/week @ 2024-09-10 283/week @ 2024-09-17 179/week @ 2024-09-24 296/week @ 2024-10-01 331/week @ 2024-10-08 429/week @ 2024-10-15 379/week @ 2024-10-22 462/week @ 2024-10-29 471/week @ 2024-11-05

1,791 downloads per month

MIT/Apache

13KB
201 lines

serde-bool

crates.io Documentation dependency status MIT or Apache 2.0 licensed
CI codecov Version Download

Single value, true or false, boolean deserializers.

Examples

Supporting serde untagged enums where only one boolean value is valid, allowing fallthrough to the next variant. Avoids need to wrap all fields in Option<_> just in case feature is disabled.

#[derive(Debug, serde::Deserialize)]
struct Config {
    feature: FeatureConfig,
}

#[derive(Debug, serde::Deserialize)]
#[serde(untagged)]
enum FeatureConfig {
    Disabled {
        enabled: serde_bool::False
    },

    Enabled {
        #[serde(default)]
        enabled: serde_bool::True,
        key: String,
        secret: String,
    }
}

// disabled variant is matched
let config = toml::from_str::<Config>(r#"
    [feature]
    enabled = false
"#).unwrap();
assert!(matches!(config.feature, FeatureConfig::Disabled { .. }));

// if the type used `enabled: bool`, this would cause issues and require Option<_> wrappers plus
// further validation... instead an error is returned immediately regarding the missing fields
let config = toml::from_str::<Config>(r#"
    [feature]
    enabled = true
"#).unwrap_err();

// using a `#[serde(default)]` annotation makes `enabled = true` optional here
let config = toml::from_str::<Config>(r#"
    [feature]
    key = "foo"
    secret = "bar"
"#).unwrap();
assert!(matches!(config.feature, FeatureConfig::Enabled { .. }));

// extra keys can exists in the disabled case, but as usual will not be captured
let config = toml::from_str::<Config>(r#"
    [feature]
    enabled = false
    key = "foo"
    secret = "bar"
"#).unwrap();
assert!(matches!(config.feature, FeatureConfig::Disabled { .. }));

Dependencies

~100–330KB