Struct Serializer 

pub struct Serializer<W: Write> {
    output: W,
    pretty: Option<(PrettyConfig, Pretty)>,
    default_extensions: Extensions,
    is_empty: Option<bool>,
    newtype_variant: bool,
    recursion_limit: Option<usize>,
    implicit_some_depth: usize,
}

The RON serializer.

You can just use to_string for deserializing a value. If you want it pretty-printed, take a look at to_string_pretty.

Fields

output: W

pretty: Option<(PrettyConfig, Pretty)>

default_extensions: Extensions

is_empty: Option<bool>

newtype_variant: bool

recursion_limit: Option<usize>

implicit_some_depth: usize

Implementations

impl<W: Write> Serializer<W>

pub fn new(writer: W, config: Option<PrettyConfig>) -> Result<Self>

Creates a new Serializer.

Most of the time you can just use to_string or to_string_pretty.

pub fn with_options( writer: W, config: Option<PrettyConfig>, options: &Options, ) -> Result<Self>

Creates a new Serializer.

Most of the time you can just use to_string or to_string_pretty.

fn separate_tuple_members(&self) -> bool

fn compact_arrays(&self) -> bool

fn compact_structs(&self) -> bool

fn compact_maps(&self) -> bool

fn number_suffixes(&self) -> bool

fn extensions(&self) -> Extensions

fn escape_strings(&self) -> bool

fn start_indent(&mut self) -> Result<()>

fn indent(&mut self) -> Result

fn end_indent(&mut self) -> Result

fn serialize_escaped_str(&mut self, value: &str) -> Result

fn serialize_unescaped_or_raw_str(&mut self, value: &str) -> Result

fn serialize_escaped_byte_str(&mut self, value: &[u8]) -> Result

fn serialize_unescaped_or_raw_byte_str(&mut self, value: &str) -> Result

fn serialize_sint(&mut self, value: impl Into<i64>, suffix: &str) -> Result<()>

fn serialize_uint(&mut self, value: impl Into<u64>, suffix: &str) -> Result<()>

fn write_identifier(&mut self, name: &str) -> Result<()>

fn validate_identifier(&self, name: &str) -> Result<()>

fn struct_names(&self) -> bool

Checks if struct names should be emitted

Note that when using the explicit_struct_names extension, this method will use an OR operation on the extension and the PrettyConfig::struct_names option. See also Extensions::EXPLICIT_STRUCT_NAMES for the extension equivalent.

Trait Implementations

impl<'a, W: Write> Serializer for &'a mut Serializer<W>

type Error = Error

The error type when some error occurs during serialization.

type Ok = ()

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 SerializeMap = Compound<'a, W>

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

type SerializeSeq = Compound<'a, W>

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

type SerializeStruct = Compound<'a, W>

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

type SerializeStructVariant = Compound<'a, W>

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

type SerializeTuple = Compound<'a, W>

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

type SerializeTupleStruct = Compound<'a, W>

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

type SerializeTupleVariant = Compound<'a, W>

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

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

Serialize a bool value.

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

Serialize an i8 value.

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

Serialize an i16 value.

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

Serialize an i32 value.

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

Serialize an i64 value.

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

Serialize a u8 value.

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

Serialize a u16 value.

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

Serialize a u32 value.

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

Serialize a u64 value.

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

Serialize an f32 value.

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

Serialize an f64 value.

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

Serialize a character.

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

Serialize a &str.

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

Serialize a chunk of raw byte data.

fn serialize_none(self) -> Result<()>

Serialize a None value.

fn serialize_some<T>(self, value: &T) -> Result<()>

where T: ?Sized + Serialize,

Serialize a Some(T) value.

fn serialize_unit(self) -> Result<()>

Serialize a () value.

fn serialize_unit_struct(self, name: &'static str) -> Result<()>

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

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

Serialize a unit variant like E::A in enum E { A, B }.

fn serialize_newtype_struct<T>( self, name: &'static str, value: &T, ) -> Result<()>

where T: ?Sized + Serialize,

Serialize a newtype struct like struct Millimeters(u8).

fn serialize_newtype_variant<T>( self, name: &'static str, _variant_index: u32, variant: &'static str, value: &T, ) -> Result<()>

where T: ?Sized + Serialize,

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

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

Begin to serialize a variably sized sequence. This call must be followed by zero or more calls to serialize_element, then a call to end.

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

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>

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>

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_map(self, len: Option<usize>) -> Result<Self::SerializeMap>

Begin to serialize a map. This call must be followed by zero or more calls to serialize_key and serialize_value, then a call to end.

fn serialize_struct( self, name: &'static str, len: usize, ) -> Result<Self::SerializeStruct>

Begin to serialize a struct like struct Rgb { 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 serialize_struct_variant( self, name: &'static str, _variant_index: u32, variant: &'static str, len: usize, ) -> Result<Self::SerializeStructVariant>

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 serialize_i128(self, v: i128) -> Result<Self::Ok, Self::Error>

Serialize an i128 value.

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

Serialize a u128 value.

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.