Struct serde_hjson::value::Serializer

pub struct Serializer { /* private fields */ }

Create a serde::Serializer that serializes a Serializee into a Value.

Implementations

impl Serializer

pub fn new() -> Serializer

Construct a new Serializer.

pub fn unwrap(self) -> Value

Unwrap the Serializer and return the Value.

Trait Implementations

impl Default for Serializer

fn default() -> Self

Returns the “default value” for a type.

impl Serializer for Serializer

type Error = Error

The error type that can be returned if some error occurs during serialization.

type SeqState = Vec<Value>

A state object that is initialized by serialize_seq, passed to serialize_seq_elt, and consumed by serialize_seq_end. Use () if no state is required.

type TupleState = Vec<Value>

A state object that is initialized by serialize_tuple, passed to serialize_tuple_elt, and consumed by serialize_tuple_end. Use () if no state is required.

type TupleStructState = Vec<Value>

A state object that is initialized by serialize_tuple_struct, passed to serialize_tuple_struct_elt, and consumed by serialize_tuple_struct_end. Use () if no state is required.

type TupleVariantState = TupleVariantState

A state object that is initialized by serialize_tuple_variant, passed to serialize_tuple_variant_elt, and consumed by serialize_tuple_variant_end. Use () if no state is required.

type MapState = MapState

A state object that is initialized by serialize_map, passed to serialize_map_elt, and consumed by serialize_map_end. Use () if no state is required.

type StructState = MapState

A state object that is initialized by serialize_struct, passed to serialize_struct_elt, and consumed by serialize_struct_end. Use () if no state is required.

type StructVariantState = StructVariantState

A state object that is initialized by serialize_struct_variant, passed to serialize_struct_variant_elt, and consumed by serialize_struct_variant_end. Use () if no state is required.

fn serialize_bool(&mut self, value: bool) -> Result<(), Error>

Serializes a bool value.

fn serialize_isize(&mut self, value: isize) -> Result<(), Error>

Serializes an isize value. If the format does not differentiate between isize and i64, a reasonable implementation would be to cast the value to i64 and forward to serialize_i64.

fn serialize_i8(&mut self, value: i8) -> Result<(), Error>

Serializes an i8 value. If the format does not differentiate between i8 and i64, a reasonable implementation would be to cast the value to i64 and forward to serialize_i64.

fn serialize_i16(&mut self, value: i16) -> Result<(), Error>

Serializes an i16 value. If the format does not differentiate between i16 and i64, a reasonable implementation would be to cast the value to i64 and forward to serialize_i64.

fn serialize_i32(&mut self, value: i32) -> Result<(), Error>

Serializes an i32 value. If the format does not differentiate between i32 and i64, a reasonable implementation would be to cast the value to i64 and forward to serialize_i64.

fn serialize_i64(&mut self, value: i64) -> Result<(), Error>

Serializes an i64 value.

fn serialize_usize(&mut self, value: usize) -> Result<(), Error>

Serializes a usize value. If the format does not differentiate between usize and u64, a reasonable implementation would be to cast the value to u64 and forward to serialize_u64.

fn serialize_u8(&mut self, value: u8) -> Result<(), Error>

Serializes a u8 value. If the format does not differentiate between u8 and u64, a reasonable implementation would be to cast the value to u64 and forward to serialize_u64.

fn serialize_u16(&mut self, value: u16) -> Result<(), Error>

Serializes a u16 value. If the format does not differentiate between u16 and u64, a reasonable implementation would be to cast the value to u64 and forward to serialize_u64.

fn serialize_u32(&mut self, value: u32) -> Result<(), Error>

Serializes a u32 value. If the format does not differentiate between u32 and u64, a reasonable implementation would be to cast the value to u64 and forward to serialize_u64.

fn serialize_u64(&mut self, value: u64) -> Result<(), Error>

Serializes a u64` value.

fn serialize_f32(&mut self, value: f32) -> Result<(), Error>

Serializes an f32 value. If the format does not differentiate between f32 and f64, a reasonable implementation would be to cast the value to f64 and forward to serialize_f64.

fn serialize_f64(&mut self, value: f64) -> Result<(), Error>

Serializes an f64 value.

fn serialize_char(&mut self, value: char) -> Result<(), Error>

Serializes a character. If the format does not support characters, it is reasonable to serialize it as a single element str or a u32.

fn serialize_str(&mut self, value: &str) -> Result<(), Error>

Serializes a &str.

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

Enables serializers to serialize byte slices more compactly or more efficiently than other types of slices. If no efficient implementation is available, a reasonable implementation would be to forward to serialize_seq. If forwarded, the implementation looks usually just like this:

fn serialize_unit(&mut self) -> Result<(), Error>

Serializes a () value. It’s reasonable to just not serialize anything.

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

Serializes a unit struct value. A reasonable implementation would be to forward to serialize_unit.

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

Serializes a unit variant, otherwise known as a variant with no arguments. A reasonable implementation would be to forward to serialize_unit.

fn serialize_newtype_struct<T>(
    &mut self,
    _name: &'static str,
    value: T
) -> Result<(), Error> where
    T: Serialize, 

Allows a tuple struct with a single element, also known as a newtype struct, to be more efficiently serialized than a tuple struct with multiple items. A reasonable implementation would be to forward to serialize_tuple_struct or to just serialize the inner value without wrapping.

fn serialize_newtype_variant<T>(
    &mut self,
    _name: &'static str,
    _variant_index: usize,
    variant: &'static str,
    value: T
) -> Result<(), Error> where
    T: Serialize, 

Allows a variant with a single item to be more efficiently serialized than a variant with multiple items. A reasonable implementation would be to forward to serialize_tuple_variant.

fn serialize_none(&mut self) -> Result<(), Error>

Serializes a None value.

fn serialize_some<V>(&mut self, value: V) -> Result<(), Error> where
    V: Serialize, 

Serializes a Some(...) value.

fn serialize_seq(&mut self, len: Option<usize>) -> Result<Vec<Value>, Error>

Begins to serialize a sequence. This call must be followed by zero or more calls to serialize_seq_elt, then a call to serialize_seq_end.

fn serialize_seq_elt<T: Serialize>(
    &mut self,
    state: &mut Vec<Value>,
    value: T
) -> Result<(), Error> where
    T: Serialize, 

Serializes a sequence element. Must have previously called serialize_seq.

fn serialize_seq_end(&mut self, state: Vec<Value>) -> Result<(), Error>

Finishes serializing a sequence.

fn serialize_seq_fixed_size(&mut self, size: usize) -> Result<Vec<Value>, Error>

Begins to serialize a sequence whose length will be known at deserialization time. This call must be followed by zero or more calls to serialize_seq_elt, then a call to serialize_seq_end. A reasonable implementation would be to forward to serialize_seq.

fn serialize_tuple(&mut self, len: usize) -> Result<Vec<Value>, Error>

Begins to serialize a tuple. This call must be followed by zero or more calls to serialize_tuple_elt, then a call to serialize_tuple_end. A reasonable implementation would be to forward to serialize_seq.

fn serialize_tuple_elt<T: Serialize>(
    &mut self,
    state: &mut Vec<Value>,
    value: T
) -> Result<(), Error>

Serializes a tuple element. Must have previously called serialize_tuple.

fn serialize_tuple_end(&mut self, state: Vec<Value>) -> Result<(), Error>

Finishes serializing a tuple.

fn serialize_tuple_struct(
    &mut self,
    _name: &'static str,
    len: usize
) -> Result<Vec<Value>, Error>

Begins to serialize a tuple struct. This call must be followed by zero or more calls to serialize_tuple_struct_elt, then a call to serialize_tuple_struct_end. A reasonable implementation would be to forward to serialize_tuple.

fn serialize_tuple_struct_elt<T: Serialize>(
    &mut self,
    state: &mut Vec<Value>,
    value: T
) -> Result<(), Error>

Serializes a tuple struct element. Must have previously called serialize_tuple_struct.

fn serialize_tuple_struct_end(&mut self, state: Vec<Value>) -> Result<(), Error>

Finishes serializing a tuple struct.

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

Begins to serialize a tuple variant. This call must be followed by zero or more calls to serialize_tuple_variant_elt, then a call to serialize_tuple_variant_end. A reasonable implementation would be to forward to serialize_tuple_struct.

fn serialize_tuple_variant_elt<T: Serialize>(
    &mut self,
    state: &mut TupleVariantState,
    value: T
) -> Result<(), Error>

Serializes a tuple variant element. Must have previously called serialize_tuple_variant.

fn serialize_tuple_variant_end(
    &mut self,
    state: TupleVariantState
) -> Result<(), Error>

Finishes serializing a tuple variant.

fn serialize_map(&mut self, _len: Option<usize>) -> Result<MapState, Error>

Begins to serialize a map. This call must be followed by zero or more calls to serialize_map_key and serialize_map_value, then a call to serialize_map_end.

fn serialize_map_key<T: Serialize>(
    &mut self,
    state: &mut MapState,
    key: T
) -> Result<(), Error>

Serialize a map key. Must have previously called serialize_map.

fn serialize_map_value<T: Serialize>(
    &mut self,
    state: &mut MapState,
    value: T
) -> Result<(), Error>

Serialize a map value. Must have previously called serialize_map.

fn serialize_map_end(&mut self, state: MapState) -> Result<(), Error>

Finishes serializing a map.

fn serialize_struct(
    &mut self,
    _name: &'static str,
    len: usize
) -> Result<MapState, Error>

Begins to serialize a struct. This call must be followed by zero or more calls to serialize_struct_elt, then a call to serialize_struct_end.

fn serialize_struct_elt<V: Serialize>(
    &mut self,
    state: &mut MapState,
    key: &'static str,
    value: V
) -> Result<(), Error>

Serializes a struct field. Must have previously called serialize_struct.

fn serialize_struct_end(&mut self, state: MapState) -> Result<(), Error>

Finishes serializing a struct.

fn serialize_struct_variant(
    &mut self,
    _name: &'static str,
    _variant_index: usize,
    variant: &'static str,
    _len: usize
) -> Result<StructVariantState, Error>

Begins to serialize a struct variant. This call must be followed by zero or more calls to serialize_struct_variant_elt, then a call to serialize_struct_variant_end.

fn serialize_struct_variant_elt<V: Serialize>(
    &mut self,
    state: &mut StructVariantState,
    key: &'static str,
    value: V
) -> Result<(), Error>

Serialize a struct variant element. Must have previously called serialize_struct_variant.

fn serialize_struct_variant_end(
    &mut self,
    state: StructVariantState
) -> Result<(), Error>

Finishes serializing a struct variant.