Struct serde_with::IfIsHumanReadable

pub struct IfIsHumanReadable<H, F = Same>(/* private fields */);

Use the first format if De/Serializer::is_human_readable, otherwise use the second

If the second format is not specified, the normal Deserialize/Serialize traits are used.

Examples

use std::time::Duration;

#[serde_as]
#[derive(Deserialize, Serialize)]
struct A {
    #[serde_as(as = "IfIsHumanReadable<DisplayFromStr>")]
    number: u32,
}
let x = A {
    number: 777,
};
assert_eq!(json!({ "number": "777" }), serde_json::to_value(&x).unwrap());
assert_eq!(vec![145, 205, 3, 9], rmp_serde::to_vec(&x).unwrap());

#[serde_as]
#[derive(Deserialize, Serialize)]
struct B {
    #[serde_as(as = "IfIsHumanReadable<DurationMilliSeconds, DurationSeconds>")]
    duration: Duration,
}
let x = B {
    duration: Duration::from_millis(1500),
};
assert_eq!(json!({ "duration": 1500 }), serde_json::to_value(&x).unwrap());
assert_eq!(vec![145, 2], rmp_serde::to_vec(&x).unwrap());

Trait Implementations

impl<'de, T, H, F> DeserializeAs<'de, T> for IfIsHumanReadable<H, F>

where H: DeserializeAs<'de, T>, F: DeserializeAs<'de, T>,

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, TA, FA> JsonSchemaAs<T> for IfIsHumanReadable<TA, FA>

where TA: JsonSchemaAs<T>,

Available on crate feature schemars_0_8 only.

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(gen: &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<T, H, F> SerializeAs<T> for IfIsHumanReadable<H, F>

where T: ?Sized, H: SerializeAs<T>, F: SerializeAs<T>,

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

where S: Serializer,

Serialize this value into the given Serde serializer.