#serialize-deserialize #serialization #serde #json-key

no-std monostate

Type that deserializes only from one specific value

14 releases

0.1.13 May 6, 2024
0.1.11 Jan 2, 2024
0.1.10 Nov 14, 2023
0.1.9 Jul 21, 2023
0.1.0 Jan 25, 2022

#1090 in Encoding

Download history 36136/week @ 2024-08-21 32674/week @ 2024-08-28 35837/week @ 2024-09-04 35669/week @ 2024-09-11 35904/week @ 2024-09-18 41599/week @ 2024-09-25 55220/week @ 2024-10-02 52960/week @ 2024-10-09 59746/week @ 2024-10-16 61203/week @ 2024-10-23 56203/week @ 2024-10-30 53853/week @ 2024-11-06 55337/week @ 2024-11-13 60914/week @ 2024-11-20 60813/week @ 2024-11-27 53487/week @ 2024-12-04

241,394 downloads per month
Used in 129 crates (19 directly)

MIT/Apache

52KB
1.5K SLoC

Monostate

github crates.io docs.rs build status

This library implements a type macro for a zero-sized type that is Serde deserializable only from one specific value.

[dependencies]
monostate = "0.1"

Examples

use monostate::MustBe;
use serde::Deserialize;

#[derive(Deserialize)]
struct Example {
    kind: MustBe!("success"),
    code: MustBe!(200),
}

The above struct would deserialize from {"kind":"success", "code":200} in JSON, but would fail the deserialization if "kind" or "code" were any other value.

This can sometimes be helpful in processing untagged enums in which the variant identification is more convoluted than what is handled by Serde's externally tagged and internally tagged representations, for example because the variant tag has an inconsistent type or key.

use monostate::MustBe;
use serde::Deserialize;

#[derive(Deserialize)]
#[serde(untagged)]
pub enum ApiResponse {
    Success {
        success: MustBe!(true),
    },
    Error {
        kind: MustBe!("error"),
        message: String,
    },
}

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

~0.3–0.9MB
~21K SLoC