serde_with 2.1.0

Custom de/serialization functions for Rust's serde
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

//! De/Serialization of JSON
//!
//! This modules is only available when using the `json` feature of the crate.

use crate::prelude::*;

/// Serialize value as string containing JSON
///
/// *Note*: This type is not necessary for normal usage of serde with JSON.
/// It is only required if the serialized format contains a string, which itself contains JSON.
///
/// # Errors
///
/// Serialization can fail if `T`'s implementation of `Serialize` decides to
/// fail, or if `T` contains a map with non-string keys.
///
/// # Examples
///
/// ```
/// # #[cfg(feature = "macros")] {
/// # use serde::{Deserialize, Serialize};
/// # use serde_with::{serde_as, json::JsonString};
/// #
/// #[serde_as]
/// #[derive(Deserialize, Serialize)]
/// struct A {
///     #[serde_as(as = "JsonString")]
///     other_struct: B,
/// }
/// #[derive(Deserialize, Serialize)]
/// struct B {
///     value: usize,
/// }
///
/// let v: A = serde_json::from_str(r#"{"other_struct":"{\"value\":5}"}"#).unwrap();
/// assert_eq!(5, v.other_struct.value);
///
/// let x = A {
///     other_struct: B { value: 10 },
/// };
/// assert_eq!(
///     r#"{"other_struct":"{\"value\":10}"}"#,
///     serde_json::to_string(&x).unwrap()
/// );
/// # }
/// ```
///
/// The `JsonString` converter takes a type argument, which allows altering the serialization behavior of the inner value, before it gets turned into a JSON string.
///
/// ```
/// # #[cfg(feature = "macros")] {
/// # use serde::{Deserialize, Serialize};
/// # use serde_with::{serde_as, json::JsonString};
/// # use std::collections::BTreeMap;
/// #
/// #[serde_as]
/// #[derive(Debug, Serialize, Deserialize, PartialEq)]
/// struct Struct {
///     #[serde_as(as = "JsonString<Vec<(JsonString, _)>>")]
///     value: BTreeMap<[u8; 2], u32>,
/// }
///
/// let value = Struct {
///     value: BTreeMap::from([([1, 2], 3), ([4, 5], 6)]),
/// };
/// assert_eq!(
///     r#"{"value":"[[\"[1,2]\",3],[\"[4,5]\",6]]"}"#,
///     serde_json::to_string(&value).unwrap()
/// );
/// # }
/// ```
pub struct JsonString<T = Same>(PhantomData<T>);

impl<T, TAs> SerializeAs<T> for JsonString<TAs>
where
    TAs: SerializeAs<T>,
{
    fn serialize_as<S>(source: &T, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(
            &serde_json::to_string(&SerializeAsWrap::<T, TAs>::new(source))
                .map_err(SerError::custom)?,
        )
    }
}

impl<'de, T, TAs> DeserializeAs<'de, T> for JsonString<TAs>
where
    TAs: for<'a> DeserializeAs<'a, T>,
{
    fn deserialize_as<D>(deserializer: D) -> Result<T, D::Error>
    where
        D: Deserializer<'de>,
    {
        struct Helper<S, SAs>(PhantomData<(S, SAs)>);

        impl<'de, S, SAs> Visitor<'de> for Helper<S, SAs>
        where
            SAs: for<'a> DeserializeAs<'a, S>,
        {
            type Value = S;

            fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
                formatter.write_str("valid json object")
            }

            fn visit_str<E>(self, value: &str) -> Result<S, E>
            where
                E: DeError,
            {
                serde_json::from_str(value)
                    .map(DeserializeAsWrap::<S, SAs>::into_inner)
                    .map_err(DeError::custom)
            }
        }

        deserializer.deserialize_str(Helper::<T, TAs>(PhantomData))
    }
}