wasm_bindgen_utils/ser.rs
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 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
use std::collections::{BTreeMap, HashMap};
use serde::{ser::SerializeStruct, Serialize, Serializer};
/// Serializer fn for serializing Vec\<u8\> as bytes (Uint8Array for js)
/// Example:
/// ```ignore
/// #[derive(serde::Serialize, serde::Deserialize)]
/// struct A {
/// #[serde(serialize_with = "serilialize_as_bytes")]
/// field: Vec<u8>,
/// }
/// ```
pub fn serilialize_as_bytes<S: Serializer>(val: &[u8], serializer: S) -> Result<S::Ok, S::Error> {
serializer.serialize_bytes(val)
}
/// Serializer fn that serializes HashMap as k/v object.
/// in js it would be plain js object and not js Map.
///
/// The [HashMap]'s keys should either be String or impl
/// [ToString] trait so that they can be converted to a
/// valid string key when serialized.
/// The [HashMap]'s entry values should themselves impl
/// [Serialize] as well.
///
/// This provides great level of flexibilty to specify a
/// specific property of the given type and not all of the
/// properties to be serialized as js plain object instead
/// of js Map when wasm_bindgen convert traits are implemented
/// for the given type by using [impl_wasm_traits](crate::impl_wasm_traits)
///
/// Example:
/// ```ignore
/// #[derive(serde::Serialize, serde::Deserialize, Tsify)]
/// struct A {
/// #[cfg_attr(
/// target_family = "wasm",
/// serde(serialize_with = "serialize_hashmap_as_object"),
/// tsify(type = "Record<string, number>")
/// )]
/// field: HashMap<String, u8>,
/// }
/// #[cfg(target_family = "wasm")]
/// impl_all_wasm_traits!(A);
///
/// #[wasm_bindgen]
/// pub fn some_fn() -> A {
/// let mut rust_map = HashMap::new();
/// rust_map.insert("key".to_string(), 1);
/// rust_map.insert("otherKey".to_string(), 2);
///
/// // in js when some_fn() is called the result will be:
/// // { field: { key: 1, otherKey: 2 } }
/// A { field: rust_map }
/// }
/// ```
pub fn serialize_hashmap_as_object<K, V, S>(
val: &HashMap<K, V>,
serializer: S,
) -> Result<S::Ok, S::Error>
where
K: ToString,
V: Serialize,
S: Serializer,
{
let mut ser = serializer.serialize_struct("HashMap", val.len())?;
for (key, value) in val {
// static str is not actually needed since we are dealing
// with a hashmap which its keys can change at runtime
// so we can safely deref the &str for this purpose
let key = unsafe { &*(key.to_string().as_str() as *const str) };
ser.serialize_field(key, value)?;
}
ser.end()
}
/// Serializer fn that serializes BTreeMap as k/v object.
/// in js it would be plain js object and not js Map.
///
/// The [BTreeMap]'s keys should either be String or impl
/// [ToString] trait so that they can be converted to a
/// valid string key when serialized.
/// The [BTreeMap]'s entry values should themselves impl
/// [Serialize] as well.
///
/// This provides great level of flexibilty to specify a
/// specific property of the given type and not all of the
/// properties to be serialized as js plain object instead
/// of js Map when wasm_bindgen convert traits are implemented
/// for the given type by using [impl_wasm_traits](crate::impl_wasm_traits)
///
/// Example:
/// ```ignore
/// #[derive(serde::Serialize, serde::Deserialize, Tsify)]
/// struct A {
/// #[cfg_attr(
/// target_family = "wasm",
/// serde(serialize_with = "serialize_hashmap_as_object"),
/// tsify(type = "Record<string, number>")
/// )]
/// field: BTreeMap<String, u8>,
/// }
/// #[cfg(target_family = "wasm")]
/// impl_all_wasm_traits!(A);
///
/// #[wasm_bindgen]
/// pub fn some_fn() -> A {
/// let mut rust_map = BTreeMAp::new();
/// rust_map.insert("key".to_string(), 1);
/// rust_map.insert("otherKey".to_string(), 2);
///
/// // in js when some_fn() is called the result will be:
/// // { field: { key: 1, otherKey: 2 } }
/// A { field: rust_map }
/// }
/// ```
pub fn serialize_btreemap_as_object<K, V, S>(
val: &BTreeMap<K, V>,
serializer: S,
) -> Result<S::Ok, S::Error>
where
K: ToString,
V: Serialize,
S: Serializer,
{
let mut ser = serializer.serialize_struct("BTreeMap", val.len())?;
for (key, value) in val {
// static str is not actually needed since we are dealing
// with a btreemap which its keys can change at runtime
// so we can safely deref the &str for this purpose
let key = unsafe { &*(key.to_string().as_str() as *const str) };
ser.serialize_field(key, value)?;
}
ser.end()
}
#[cfg(target_family = "wasm")]
#[cfg(test)]
mod tests {
use super::*;
use std::collections::HashMap;
use wasm_bindgen_test::wasm_bindgen_test;
use serde_test::{assert_de_tokens, assert_ser_tokens, Token};
#[wasm_bindgen_test]
fn test_byte_serializer() {
#[derive(serde::Serialize, serde::Deserialize, PartialEq, Debug)]
struct Bytes {
#[serde(serialize_with = "serilialize_as_bytes")]
field: Vec<u8>,
}
let bytes = Bytes {
field: vec![1, 2, 3, 4, 5, 6],
};
assert_ser_tokens(
&bytes,
&[
Token::Struct {
name: "Bytes",
len: 1,
},
Token::Str("field"),
Token::Bytes(&[1, 2, 3, 4, 5, 6]),
Token::StructEnd,
],
);
assert_de_tokens(
&bytes,
&[
Token::Struct {
name: "Bytes",
len: 1,
},
Token::Str("field"),
Token::Seq { len: Some(6) },
Token::U8(1),
Token::U8(2),
Token::U8(3),
Token::U8(4),
Token::U8(5),
Token::U8(6),
Token::SeqEnd,
Token::StructEnd,
],
);
}
#[wasm_bindgen_test]
fn test_map_serializer() {
#[derive(serde::Serialize, serde::Deserialize, PartialEq, Debug)]
struct Test {
#[serde(serialize_with = "serialize_hashmap_as_object")]
field: HashMap<String, String>,
}
let mut hashmap = HashMap::new();
hashmap.insert("key1".to_string(), "some value".to_string());
hashmap.insert("key2".to_string(), "some other value".to_string());
let test = Test { field: hashmap };
assert_ser_tokens(
&test,
&[
Token::Struct {
name: "Test",
len: 1,
},
Token::Str("field"),
Token::Struct {
name: "HashMap",
len: 2,
},
Token::Str("key1"),
Token::Str("some value"),
Token::Str("key2"),
Token::Str("some other value"),
Token::StructEnd,
Token::StructEnd,
],
);
assert_de_tokens(
&test,
&[
Token::Struct {
name: "Test",
len: 1,
},
Token::Str("field"),
Token::Map { len: Some(2) },
Token::Str("key1"),
Token::Str("some value"),
Token::Str("key2"),
Token::Str("some other value"),
Token::MapEnd,
Token::StructEnd,
],
);
}
#[wasm_bindgen_test]
fn test_bmap_serializer() {
#[derive(serde::Serialize, serde::Deserialize, PartialEq, Debug)]
struct Test {
#[serde(serialize_with = "serialize_btreemap_as_object")]
field: BTreeMap<String, u8>,
}
let mut bmap = BTreeMap::new();
bmap.insert("key1".to_string(), 8);
bmap.insert("key2".to_string(), 9);
let test = Test { field: bmap };
assert_ser_tokens(
&test,
&[
Token::Struct {
name: "Test",
len: 1,
},
Token::Str("field"),
Token::Struct {
name: "BTreeMap",
len: 2,
},
Token::Str("key1"),
Token::U8(8),
Token::Str("key2"),
Token::U8(9),
Token::StructEnd,
Token::StructEnd,
],
);
assert_de_tokens(
&test,
&[
Token::Struct {
name: "Test",
len: 1,
},
Token::Str("field"),
Token::Map { len: Some(2) },
Token::Str("key1"),
Token::U8(8),
Token::Str("key2"),
Token::U8(9),
Token::MapEnd,
Token::StructEnd,
],
);
}
}