Struct serde_with::BoolFromInt

pub struct BoolFromInt<S: Strictness = Strict>(/* private fields */);

Deserialize a boolean from a number

Deserialize a number (of u8) and turn it into a boolean. The adapter supports a Strict and Flexible format. In Strict mode, the number must be 0 or 1. All other values produce an error. In Flexible mode, the number any non-zero value is converted to true.

During serialization only 0 or 1 are ever emitted.

Examples

#[serde_as]
#[derive(Deserialize, Serialize)]
struct Data(#[serde_as(as = "BoolFromInt")] bool);

let data = Data(true);
let j = json!(1);
// Ensure serialization and deserialization produce the expected results
assert_eq!(j, serde_json::to_value(&data).unwrap());
assert_eq!(data, serde_json::from_value(j).unwrap());

// false maps to 0
let data = Data(false);
let j = json!(0);
assert_eq!(j, serde_json::to_value(&data).unwrap());
assert_eq!(data, serde_json::from_value(j).unwrap());
#[serde_as]
#[derive(Deserialize, Serialize)]
struct Flexible(#[serde_as(as = "BoolFromInt<serde_with::formats::Flexible>")] bool);

// Flexible turns any non-zero number into true
let data = Flexible(true);
let j = json!(100);
assert_eq!(data, serde_json::from_value(j).unwrap());

Trait Implementations

impl<'de> DeserializeAs<'de, bool> for BoolFromInt<Strict>

fn deserialize_as<D>(deserializer: D) -> Result<bool, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> DeserializeAs<'de, bool> for BoolFromInt<Flexible>

fn deserialize_as<D>(deserializer: D) -> Result<bool, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchemaAs<bool> for BoolFromInt<Strict>

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(_: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl JsonSchemaAs<bool> for BoolFromInt<Flexible>

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(_: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<STRICTNESS: Strictness> SerializeAs<bool> for BoolFromInt<STRICTNESS>

fn serialize_as<S>(source: &bool, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.