Struct postcard::Serializer[][src]

pub struct Serializer<F> where
    F: SerFlavor
{ pub output: F, }
Expand description

A serde compatible serializer, generic over “Flavors” of serializing plugins.

It should rarely be necessary to directly use this type unless you are implementing your own SerFlavor.

See the docs for SerFlavor for more information about “flavors” of serialization

Fields

output: F
Expand description

This is the Flavor(s) that will be used to modify or store any bytes generated by serialization

Trait Implementations

impl<'a, F> SerializeMap for &'a mut Serializer<F> where
    F: SerFlavor
[src]

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

fn serialize_key<T: ?Sized>(&mut self, key: &T) -> Result<()> where
    T: Serialize
[src]

Serialize a map key. Read more

fn serialize_value<T: ?Sized>(&mut self, value: &T) -> Result<()> where
    T: Serialize
[src]

Serialize a map value. Read more

fn end(self) -> Result<()>[src]

Finish serializing a map.

fn serialize_entry<K, V>(
    &mut self,
    key: &K,
    value: &V
) -> Result<(), Self::Error> where
    V: Serialize + ?Sized,
    K: Serialize + ?Sized
[src]

Serialize a map entry consisting of a key and a value. Read more

impl<'a, F> SerializeSeq for &'a mut Serializer<F> where
    F: SerFlavor
[src]

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

fn serialize_element<T: ?Sized>(&mut self, value: &T) -> Result<()> where
    T: Serialize
[src]

Serialize a sequence element.

fn end(self) -> Result<()>[src]

Finish serializing a sequence.

impl<'a, F> SerializeStruct for &'a mut Serializer<F> where
    F: SerFlavor
[src]

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

fn serialize_field<T: ?Sized>(
    &mut self,
    _key: &'static str,
    value: &T
) -> Result<()> where
    T: Serialize
[src]

Serialize a struct field.

fn end(self) -> Result<()>[src]

Finish serializing a struct.

fn skip_field(&mut self, key: &'static str) -> Result<(), Self::Error>[src]

Indicate that a struct field has been skipped.

impl<'a, F> SerializeStructVariant for &'a mut Serializer<F> where
    F: SerFlavor
[src]

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

fn serialize_field<T: ?Sized>(
    &mut self,
    _key: &'static str,
    value: &T
) -> Result<()> where
    T: Serialize
[src]

Serialize a struct variant field.

fn end(self) -> Result<()>[src]

Finish serializing a struct variant.

fn skip_field(&mut self, key: &'static str) -> Result<(), Self::Error>[src]

Indicate that a struct variant field has been skipped.

impl<'a, F> SerializeTuple for &'a mut Serializer<F> where
    F: SerFlavor
[src]

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

fn serialize_element<T: ?Sized>(&mut self, value: &T) -> Result<()> where
    T: Serialize
[src]

Serialize a tuple element.

fn end(self) -> Result<()>[src]

Finish serializing a tuple.

impl<'a, F> SerializeTupleStruct for &'a mut Serializer<F> where
    F: SerFlavor
[src]

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

fn serialize_field<T: ?Sized>(&mut self, value: &T) -> Result<()> where
    T: Serialize
[src]

Serialize a tuple struct field.

fn end(self) -> Result<()>[src]

Finish serializing a tuple struct.

impl<'a, F> SerializeTupleVariant for &'a mut Serializer<F> where
    F: SerFlavor
[src]

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

fn serialize_field<T: ?Sized>(&mut self, value: &T) -> Result<()> where
    T: Serialize
[src]

Serialize a tuple variant field.

fn end(self) -> Result<()>[src]

Finish serializing a tuple variant.

impl<'a, F> Serializer for &'a mut Serializer<F> where
    F: SerFlavor
[src]

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

type Error = Error

The error type when some error occurs during serialization.

type SerializeSeq = Self

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

type SerializeTuple = Self

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

type SerializeTupleStruct = Self

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

type SerializeTupleVariant = Self

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

type SerializeMap = Self

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

type SerializeStruct = Self

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

type SerializeStructVariant = Self

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

fn is_human_readable(&self) -> bool[src]

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

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

Serialize a bool value. Read more

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

Serialize an i8 value. Read more

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

Serialize an i16 value. Read more

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

Serialize an i32 value. Read more

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

Serialize an i64 value. Read more

fn serialize_i128(self, v: i128) -> Result<()>[src]

Serialize an i128 value. Read more

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

Serialize a u8 value. Read more

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

Serialize a u16 value. Read more

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

Serialize a u32 value. Read more

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

Serialize a u64 value. Read more

fn serialize_u128(self, v: u128) -> Result<()>[src]

Serialize a u128 value. Read more

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

Serialize an f32 value. Read more

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

Serialize an f64 value. Read more

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

Serialize a character. Read more

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

Serialize a &str. Read more

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

Serialize a chunk of raw byte data. Read more

fn serialize_none(self) -> Result<()>[src]

Serialize a None value. Read more

fn serialize_some<T: ?Sized>(self, value: &T) -> Result<()> where
    T: Serialize
[src]

Serialize a Some(T) value. Read more

fn serialize_unit(self) -> Result<()>[src]

Serialize a () value. Read more

fn serialize_unit_struct(self, _name: &'static str) -> Result<()>[src]

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

fn serialize_unit_variant(
    self,
    _name: &'static str,
    variant_index: u32,
    _variant: &'static str
) -> Result<()>
[src]

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

fn serialize_newtype_struct<T: ?Sized>(
    self,
    _name: &'static str,
    value: &T
) -> Result<()> where
    T: Serialize
[src]

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

fn serialize_newtype_variant<T: ?Sized>(
    self,
    _name: &'static str,
    variant_index: u32,
    _variant: &'static str,
    value: &T
) -> Result<()> where
    T: Serialize
[src]

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

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

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

fn serialize_tuple(self, _len: usize) -> Result<Self::SerializeTuple>[src]

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

fn serialize_tuple_struct(
    self,
    _name: &'static str,
    _len: usize
) -> Result<Self::SerializeTupleStruct>
[src]

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

fn serialize_tuple_variant(
    self,
    _name: &'static str,
    variant_index: u32,
    _variant: &'static str,
    _len: usize
) -> Result<Self::SerializeTupleVariant>
[src]

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

fn serialize_map(self, len: Option<usize>) -> Result<Self::SerializeMap>[src]

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

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

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

fn serialize_struct_variant(
    self,
    _name: &'static str,
    variant_index: u32,
    _variant: &'static str,
    _len: usize
) -> Result<Self::SerializeStructVariant>
[src]

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

fn collect_str<T: ?Sized>(self, _value: &T) -> Result<Self::Ok> where
    T: Display
[src]

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

fn collect_seq<I>(self, iter: I) -> Result<Self::Ok, Self::Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Serialize
[src]

Collect an iterator as a sequence. Read more

fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error> where
    V: Serialize,
    K: Serialize,
    I: IntoIterator<Item = (K, V)>, 
[src]

Collect an iterator as a map. Read more

Auto Trait Implementations

impl<F> RefUnwindSafe for Serializer<F> where
    F: RefUnwindSafe

impl<F> Send for Serializer<F> where
    F: Send

impl<F> Sync for Serializer<F> where
    F: Sync

impl<F> Unpin for Serializer<F> where
    F: Unpin

impl<F> UnwindSafe for Serializer<F> where
    F: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.