Struct Serializer

pub struct Serializer { /* private fields */ }

A serde::Serializer that converts supported Rust values into a JsValue.

Implementations

impl Serializer

pub const fn new() -> Self

Creates a new default Serializer.

pub const fn json_compatible() -> Self

Creates a JSON compatible serializer. This uses null instead of undefined, and uses plain objects instead of ES maps. So you will get the same result of JsValue::from_serde, and you can stringify results to JSON and store it without data loss.

pub const fn serialize_missing_as_null(self, value: bool) -> Self

Set to true to serialize (), unit structs and Option::None to null instead of undefined in JS. false by default.

pub const fn serialize_maps_as_objects(self, value: bool) -> Self

Set to true to serialize maps into plain JavaScript objects instead of ES2015 Maps. false by default.

pub const fn serialize_large_number_types_as_bigints(self, value: bool) -> Self

Set to true to serialize 64-bit numbers to JavaScript BigInt instead of plain numbers. false by default.

pub const fn serialize_bytes_as_arrays(self, value: bool) -> Self

Set to true to serialize bytes into plain JavaScript arrays instead of ES2015 Uint8Arrays. false by default.

Trait Implementations

impl Default for Serializer

fn default() -> Serializer

Returns the “default value” for a type.

impl<'s> Serializer for &'s Serializer

fn serialize_unit_variant( self, _name: &'static str, _variant_index: u32, variant: &'static str, ) -> Result<JsValue, Error>

For compatibility with serde-json, serialises unit variants as “Variant” strings.

fn serialize_seq(self, _len: Option<usize>) -> Result<Self::SerializeSeq, Error>

Serialises any Rust iterable into a JS Array.

fn serialize_map(self, _len: Option<usize>) -> Result<Self::SerializeMap, Error>

Serialises Rust maps into JS Map or plain JS objects, depending on configuration of serialize_maps_as_objects.

fn serialize_struct( self, _name: &'static str, _len: usize, ) -> Result<Self::SerializeStruct, Error>

Serialises Rust typed structs into plain JS objects.

type Ok = JsValue

The output type produced by this Serializer during successful serialization. Most serializers that produce text or binary output should set Ok = () and serialize into an io::Write or buffer contained within the Serializer instance. Serializers that build in-memory data structures may be simplified by using Ok to propagate the data structure around.

type Error = Error

The error type when some error occurs during serialization.

type SerializeSeq = ArraySerializer<'s>

Type returned from serialize_seq for serializing the content of the sequence.

type SerializeTuple = ArraySerializer<'s>

Type returned from serialize_tuple for serializing the content of the tuple.

type SerializeTupleStruct = ArraySerializer<'s>

Type returned from serialize_tuple_struct for serializing the content of the tuple struct.

type SerializeTupleVariant = VariantSerializer<ArraySerializer<'s>>

Type returned from serialize_tuple_variant for serializing the content of the tuple variant.

type SerializeMap = MapSerializer<'s>

Type returned from serialize_map for serializing the content of the map.

type SerializeStruct = ObjectSerializer<'s>

Type returned from serialize_struct for serializing the content of the struct.

type SerializeStructVariant = VariantSerializer<ObjectSerializer<'s>>

Type returned from serialize_struct_variant for serializing the content of the struct variant.

fn serialize_bool(self, v: bool) -> Result<JsValue, Error>

Serialize a bool value.

fn serialize_i8(self, v: i8) -> Result<JsValue, Error>

Serialize an i8 value.

fn serialize_i16(self, v: i16) -> Result<JsValue, Error>

Serialize an i16 value.

fn serialize_i32(self, v: i32) -> Result<JsValue, Error>

Serialize an i32 value.

fn serialize_u8(self, v: u8) -> Result<JsValue, Error>

Serialize a u8 value.

fn serialize_u16(self, v: u16) -> Result<JsValue, Error>

Serialize a u16 value.

fn serialize_u32(self, v: u32) -> Result<JsValue, Error>

Serialize a u32 value.

fn serialize_f32(self, v: f32) -> Result<JsValue, Error>

Serialize an f32 value.

fn serialize_f64(self, v: f64) -> Result<JsValue, Error>

Serialize an f64 value.

fn serialize_str(self, v: &str) -> Result<JsValue, Error>

Serialize a &str.

fn serialize_i64(self, v: i64) -> Result<JsValue, Error>

Serialize an i64 value.

fn serialize_u64(self, v: u64) -> Result<JsValue, Error>

Serialize a u64 value.

fn serialize_i128(self, v: i128) -> Result<JsValue, Error>

Serialize an i128 value.

fn serialize_u128(self, v: u128) -> Result<JsValue, Error>

Serialize a u128 value.

fn serialize_char(self, v: char) -> Result<JsValue, Error>

Serialize a character.

fn serialize_bytes(self, v: &[u8]) -> Result<JsValue, Error>

Serialize a chunk of raw byte data.

fn serialize_none(self) -> Result<JsValue, Error>

Serialize a None value.

fn serialize_some<T: ?Sized + Serialize>( self, value: &T, ) -> Result<JsValue, Error>

Serialize a Some(T) value.

fn serialize_unit(self) -> Result<JsValue, Error>

Serialize a () value.

fn serialize_unit_struct(self, _name: &'static str) -> Result<JsValue, Error>

Serialize a unit struct like struct Unit or PhantomData<T>.

fn serialize_newtype_struct<T: ?Sized + Serialize>( self, _name: &'static str, value: &T, ) -> Result<JsValue, Error>

Serialize a newtype struct like struct Millimeters(u8).

fn serialize_newtype_variant<T: ?Sized + Serialize>( self, _name: &'static str, _variant_index: u32, variant: &'static str, value: &T, ) -> Result<JsValue, Error>

Serialize a newtype variant like E::N in enum E { N(u8) }.

fn serialize_tuple(self, len: usize) -> Result<Self::SerializeTuple, Error>

Begin to serialize a statically sized sequence whose length will be known at deserialization time without looking at the serialized data. This call must be followed by zero or more calls to serialize_element, then a call to end.

fn serialize_tuple_struct( self, _name: &'static str, len: usize, ) -> Result<Self::SerializeTupleStruct, Error>

Begin to serialize a tuple struct like struct Rgb(u8, u8, u8). This call must be followed by zero or more calls to serialize_field, then a call to end.

fn serialize_tuple_variant( self, _name: &'static str, _variant_index: u32, variant: &'static str, len: usize, ) -> Result<Self::SerializeTupleVariant, Error>

Begin to serialize a tuple variant like E::T in enum E { T(u8, u8) }. This call must be followed by zero or more calls to serialize_field, then a call to end.

fn serialize_struct_variant( self, _name: &'static str, _variant_index: u32, variant: &'static str, len: usize, ) -> Result<Self::SerializeStructVariant, Error>

Begin to serialize a struct variant like E::S in enum E { S { r: u8, g: u8, b: u8 } }. This call must be followed by zero or more calls to serialize_field, then a call to end.

fn collect_seq<I>(self, iter: I) -> Result<Self::Ok, Self::Error>

where I: IntoIterator, <I as IntoIterator>::Item: Serialize,

Collect an iterator as a sequence.

fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error>

where K: Serialize, V: Serialize, I: IntoIterator<Item = (K, V)>,

Collect an iterator as a map.

fn collect_str<T>(self, value: &T) -> Result<Self::Ok, Self::Error>

where T: Display + ?Sized,

Serialize a string produced by an implementation of Display.

fn is_human_readable(&self) -> bool

Determine whether Serialize implementations should serialize in human-readable form.