Struct serde_assert::Serializer

source ·
pub struct Serializer { /* private fields */ }
Expand description

Serializer for testing Serialize implementations.

This serializer outputs Tokens representing the serialized value. The Tokens can be compared against an expected sequence of Tokens to ensure the serialization is correct.

§Configuration

The following options can be configured on the Builder:

  • is_human_readable(): Determines whether the serializer will serialize values in a readable format or a compact format. Useful for complicated structs wishing to provide different outputs depending on the readability of the serialization type.
  • serialize_struct_as(): Specifies how the serializer should serialize structs. Compact formats often serialize structs as sequences. By enabling this setting, tokens can be produced in this format, and can then be deserialized to ensure structs deserialized as sequences are deserialized correctly.

§Example

use claims::assert_ok_eq;
use serde::Serialize;
use serde_assert::{
    Serializer,
    Token,
};

let serializer = Serializer::builder().build();

assert_ok_eq!(true.serialize(&serializer), [Token::Bool(true)]);

Implementations§

source§

impl Serializer

source

pub fn builder() -> Builder

Returns a Builder for a Serializer.

§Example
use serde_assert::Serializer;

let serializer = Serializer::builder().is_human_readable(false).build();

Trait Implementations§

source§

impl Debug for Serializer

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a> Serializer for &'a Serializer

§

type Ok = Tokens

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

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

type SerializeTuple = CompoundSerializer<'a>

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

type SerializeTupleStruct = CompoundSerializer<'a>

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

type SerializeTupleVariant = CompoundSerializer<'a>

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

type SerializeMap = CompoundSerializer<'a>

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

type SerializeStruct = SerializeStruct<'a>

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

type SerializeStructVariant = CompoundSerializer<'a>

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

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

Serialize a bool value. Read more
source§

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

Serialize an i8 value. Read more
source§

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

Serialize an i16 value. Read more
source§

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

Serialize an i32 value. Read more
source§

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

Serialize an i64 value. Read more
source§

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

Serialize an i128 value. Read more
source§

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

Serialize a u8 value. Read more
source§

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

Serialize a u16 value. Read more
source§

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

Serialize a u32 value. Read more
source§

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

Serialize a u64 value. Read more
source§

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

Serialize a u128 value. Read more
source§

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

Serialize an f32 value. Read more
source§

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

Serialize an f64 value. Read more
source§

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

Serialize a character. Read more
source§

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

Serialize a &str. Read more
source§

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

Serialize a chunk of raw byte data. Read more
source§

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

Serialize a None value. Read more
source§

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

Serialize a Some(T) value. Read more
source§

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

Serialize a () value. Read more
source§

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

Serialize a unit struct like struct Unit or PhantomData<T>. Read more
source§

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

Serialize a unit variant like E::A in enum E { A, B }. Read more
source§

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

Serialize a newtype struct like struct Millimeters(u8). Read more
source§

fn serialize_newtype_variant<T>( self, name: &'static str, variant_index: u32, variant: &'static str, value: &T, ) -> Result<Tokens, Error>
where T: Serialize + ?Sized,

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

fn serialize_seq( self, len: Option<usize>, ) -> Result<CompoundSerializer<'a>, 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. Read more
source§

fn serialize_tuple(self, len: usize) -> Result<CompoundSerializer<'a>, 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. Read more
source§

fn serialize_tuple_struct( self, name: &'static str, len: usize, ) -> Result<CompoundSerializer<'a>, 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. Read more
source§

fn serialize_tuple_variant( self, name: &'static str, variant_index: u32, variant: &'static str, len: usize, ) -> Result<CompoundSerializer<'a>, 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. Read more
source§

fn serialize_map( self, len: Option<usize>, ) -> Result<CompoundSerializer<'a>, 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. Read more
source§

fn serialize_struct( self, name: &'static str, len: usize, ) -> Result<SerializeStruct<'a>, 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. Read more
source§

fn serialize_struct_variant( self, name: &'static str, variant_index: u32, variant: &'static str, len: usize, ) -> Result<CompoundSerializer<'a>, 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. Read more
source§

fn collect_str<T>(self, value: &T) -> Result<Tokens, Error>
where T: Display + ?Sized,

Serialize a string produced by an implementation of Display. Read more
source§

fn is_human_readable(&self) -> bool

Determine whether Serialize implementations should serialize in human-readable form. Read more
source§

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

Collect an iterator as a sequence. Read more
source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.