Struct serde_content::Serializer

pub struct Serializer<'a> { /* private fields */ }

A structure for serialising Rust values into crate::Value.

Implementations

impl<'a> Serializer<'a>

pub const fn new() -> Self

Creates a serializer.

The serializer created doesn’t serialize in human-readable form. To serialize in human-readable form, call Serializer::human_readable on the resulting serializer.

Examples found in repository

examples/point.rs (line 16)

fn main() -> serde_content::Result<()> {
    let point = Point { x: 1, y: 2 };

    // Convert the Point to the Value type.
    let serialized = Serializer::new().serialize(&point)?;

    // Pretty print the serialised Value.
    dbg!(&serialized);

    // Convert the Value back to a Point.
    let deserialized: Point = Deserializer::new(serialized).deserialize()?;

    // Pretty print the deserialised Point.
    dbg!(deserialized);

    Ok(())
}

pub const fn human_readable(self) -> Self

Make Serialize implementations serialize in human-readable form.

pub fn serialize<T>(self, value: T) -> Result<Value<'a>, Error>

where T: Serialize,

Convert a T into Value which is an enum that can represent any valid Rust data.

Examples found in repository

examples/point.rs (line 16)

fn main() -> serde_content::Result<()> {
    let point = Point { x: 1, y: 2 };

    // Convert the Point to the Value type.
    let serialized = Serializer::new().serialize(&point)?;

    // Pretty print the serialised Value.
    dbg!(&serialized);

    // Convert the Value back to a Point.
    let deserialized: Point = Deserializer::new(serialized).deserialize()?;

    // Pretty print the deserialised Point.
    dbg!(deserialized);

    Ok(())
}

Trait Implementations

impl<'a> Clone for Serializer<'a>

fn clone(&self) -> Serializer<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Serializer<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for Serializer<'a>

fn default() -> Serializer<'a>

Returns the “default value” for a type.

impl<'a> PartialEq for Serializer<'a>

fn eq(&self, other: &Serializer<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for Serializer<'a>

fn partial_cmp(&self, other: &Serializer<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Serializer for Serializer<'a>

type Ok = Value<'a>

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 = Seq<'a>

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

type SerializeTuple = Tuple<'a>

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

type SerializeTupleStruct = Struct<'a>

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

type SerializeTupleVariant = Enum<'a>

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

type SerializeMap = Map<'a>

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

type SerializeStruct = Struct<'a>

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

type SerializeStructVariant = Enum<'a>

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

fn serialize_bool(self, value: bool) -> Result<Self::Ok, Error>

Serialize a bool value.

fn serialize_i8(self, value: i8) -> Result<Self::Ok, Error>

Serialize an i8 value.

fn serialize_i16(self, value: i16) -> Result<Self::Ok, Error>

Serialize an i16 value.

fn serialize_i32(self, value: i32) -> Result<Self::Ok, Error>

Serialize an i32 value.

fn serialize_i64(self, value: i64) -> Result<Self::Ok, Error>

Serialize an i64 value.

fn serialize_i128(self, value: i128) -> Result<Self::Ok, Error>

Serialize an i128 value.

fn serialize_u8(self, value: u8) -> Result<Self::Ok, Error>

Serialize a u8 value.

fn serialize_u16(self, value: u16) -> Result<Self::Ok, Error>

Serialize a u16 value.

fn serialize_u32(self, value: u32) -> Result<Self::Ok, Error>

Serialize a u32 value.

fn serialize_u64(self, value: u64) -> Result<Self::Ok, Error>

Serialize a u64 value.

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

Serialize a u128 value.

fn serialize_f32(self, value: f32) -> Result<Self::Ok, Error>

Serialize an f32 value.

fn serialize_f64(self, value: f64) -> Result<Self::Ok, Error>

Serialize an f64 value.

fn serialize_char(self, value: char) -> Result<Self::Ok, Error>

Serialize a character.

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

Serialize a &str.

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

Serialize a chunk of raw byte data.

fn serialize_unit(self) -> Result<Self::Ok, Error>

Serialize a () value.

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

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<Self::Ok, Error>

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

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

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<Self::Ok, Error>

where T: ?Sized + Serialize,

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

fn serialize_none(self) -> Result<Self::Ok, Error>

Serialize a None value.

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

where T: ?Sized + Serialize,

Serialize a Some(T) value.

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

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

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, Error>

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, 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_str<T>(self, value: &T) -> Result<Self::Ok, Self::Error>

where T: ?Sized + Display,

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.

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.

impl<'a> Copy for Serializer<'a>

impl<'a> StructuralPartialEq for Serializer<'a>