Struct serde_xdr::Serializer

pub struct Serializer<'w, W> where
    W: WriteBytesExt + 'w,  { /* fields omitted */ }

Serializer for the XDR format.

Structure that holds a mutable borrow of the writer it serializes data to. It has an implementation of serde::Serializer so that it can serialize data into its XDR representation.

Implementations

impl<'w, W> Serializer<'w, W> where
    W: WriteBytesExt + 'w, 

pub fn new(writer: &'w mut W) -> Self

Create a new instance that serializes data into the given generic writer.

Trait Implementations

impl<'w, W> SerializeMap for Serializer<'w, W> where
    W: WriteBytesExt + 'w, 

type Ok = Self

Must match the Ok type of our Serializer.

type Error = CompatSerializationError

Must match the Error type of our Serializer.

pub fn serialize_key<T: ?Sized>(
    &mut self,
    _key: &T
) -> Result<(), CompatSerializationError> where
    T: Serialize, 

Serialize a map key.

pub fn serialize_value<T: ?Sized>(
    &mut self,
    _value: &T
) -> Result<(), CompatSerializationError> where
    T: Serialize, 

Serialize a map value.

pub fn end(self) -> Result<Self, CompatSerializationError>

Finish serializing a map.

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

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

impl<'w, W> Serializer for Serializer<'w, W> where
    W: WriteBytesExt + 'w, 

type Ok = Self

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 = CompatSerializationError

The error type when some error occurs during serialization.

type SerializeSeq = SequenceSerializer<'w, W>

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

type SerializeTuple = SequenceSerializer<'w, W>

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

type SerializeTupleStruct = SequenceSerializer<'w, W>

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

type SerializeTupleVariant = SequenceSerializer<'w, W>

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

type SerializeMap = Self

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

type SerializeStruct = StructSerializer<'w, W>

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

type SerializeStructVariant = StructSerializer<'w, W>

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

pub fn serialize_bool(
    self,
    value: bool
) -> Result<Self, CompatSerializationError>

Serialize a bool value.

pub fn serialize_i8(self, value: i8) -> Result<Self, CompatSerializationError>

Serialize an i8 value.

pub fn serialize_i16(self, value: i16) -> Result<Self, CompatSerializationError>

Serialize an i16 value.

pub fn serialize_i32(self, value: i32) -> Result<Self, CompatSerializationError>

Serialize an i32 value.

pub fn serialize_i64(self, value: i64) -> Result<Self, CompatSerializationError>

Serialize an i64 value.

pub fn serialize_u8(self, value: u8) -> Result<Self, CompatSerializationError>

Serialize a u8 value.

pub fn serialize_u16(self, value: u16) -> Result<Self, CompatSerializationError>

Serialize a u16 value.

pub fn serialize_u32(self, value: u32) -> Result<Self, CompatSerializationError>

Serialize a u32 value.

pub fn serialize_u64(self, value: u64) -> Result<Self, CompatSerializationError>

Serialize a u64 value.

pub fn serialize_f32(self, value: f32) -> Result<Self, CompatSerializationError>

Serialize an f32 value.

pub fn serialize_f64(self, value: f64) -> Result<Self, CompatSerializationError>

Serialize an f64 value.

pub fn serialize_char(
    self,
    value: char
) -> Result<Self, CompatSerializationError>

Serialize a character.

pub fn serialize_str(
    self,
    value: &str
) -> Result<Self, CompatSerializationError>

Serialize a &str.

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

Serialize a chunk of raw byte data.

pub fn serialize_none(self) -> Result<Self, CompatSerializationError>

Serialize a None value.

pub fn serialize_some<T: ?Sized>(
    self,
    value: &T
) -> Result<Self, CompatSerializationError> where
    T: Serialize, 

Serialize a Some(T) value.

pub fn serialize_unit(self) -> Result<Self, CompatSerializationError>

Serialize a () value.

pub fn serialize_unit_struct(
    self,
    _name: &'static str
) -> Result<Self, CompatSerializationError>

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

pub fn serialize_unit_variant(
    self,
    name: &'static str,
    variant_index: u32,
    variant: &'static str
) -> Result<Self, CompatSerializationError>

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

pub fn serialize_newtype_struct<T: ?Sized>(
    self,
    name: &'static str,
    value: &T
) -> Result<Self, CompatSerializationError> where
    T: Serialize, 

Serialize a newtype struct like struct Millimeters(u8).

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

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

pub fn serialize_seq(
    self,
    length: Option<usize>
) -> Result<Self::SerializeSeq, CompatSerializationError>

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.

pub fn serialize_tuple(
    self,
    _length: usize
) -> Result<Self::SerializeTuple, CompatSerializationError>

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.

pub fn serialize_tuple_struct(
    self,
    name: &'static str,
    _length: usize
) -> Result<Self::SerializeTupleStruct, CompatSerializationError>

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.

pub fn serialize_tuple_variant(
    self,
    name: &'static str,
    variant_index: u32,
    variant: &'static str,
    _length: usize
) -> Result<Self::SerializeTupleVariant, CompatSerializationError>

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.

pub fn serialize_map(
    self,
    _length: Option<usize>
) -> Result<Self::SerializeMap, CompatSerializationError>

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.

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

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.

pub fn serialize_struct_variant(
    self,
    name: &'static str,
    variant_index: u32,
    variant: &'static str,
    _length: usize
) -> Result<Self::SerializeStructVariant, CompatSerializationError>

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.

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

Serialize an i128 value.

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

Serialize a u128 value.

pub 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.

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

Collect an iterator as a map.

pub 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.

pub fn is_human_readable(&self) -> bool

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