Struct rmp_serde::encode::Serializer

source ·
pub struct Serializer<W, C = DefaultConfig> { /* private fields */ }
Expand description

Represents MessagePack serialization implementation.

§Note

MessagePack has no specification about how to encode enum types. Thus we are free to do whatever we want, so the given choice may be not ideal for you.

An enum value is represented as a single-entry map whose key is the variant id and whose value is a sequence containing all associated data. If the enum does not have associated data, the sequence is empty.

All instances of ErrorKind::Interrupted are handled by this function and the underlying operation is retried.

Implementations§

source§

impl<W: Write, C> Serializer<W, C>

source

pub fn get_ref(&self) -> &W

Gets a reference to the underlying writer.

source

pub fn get_mut(&mut self) -> &mut W

Gets a mutable reference to the underlying writer.

It is inadvisable to directly write to the underlying writer.

source

pub fn into_inner(self) -> W

Unwraps this Serializer, returning the underlying writer.

source§

impl<W: Write> Serializer<W, DefaultConfig>

source

pub fn new(wr: W) -> Self

Constructs a new MessagePack serializer whose output will be written to the writer specified.

§Note

This is the default constructor, which returns a serializer that will serialize structs and enums using the most compact representation.

source§

impl<W: Write, C> Serializer<W, C>

source

pub fn with_struct_map(self) -> Serializer<W, StructMapConfig<C>>

Consumes this serializer returning the new one, which will serialize structs as a map.

This is used, when the default struct serialization as a tuple does not fit your requirements.

source

pub fn with_struct_tuple(self) -> Serializer<W, StructTupleConfig<C>>

Consumes this serializer returning the new one, which will serialize structs as a tuple without field names.

This is the default MessagePack serialization mechanism, emitting the most compact representation.

source

pub fn with_human_readable(self) -> Serializer<W, HumanReadableConfig<C>>

Consumes this serializer returning the new one, which will serialize some types in human-readable representations (Serializer::is_human_readable will return true). Note that the overall representation is still binary, but some types such as IP addresses will be saved as human-readable strings.

This is primarily useful if you need to interoperate with serializations produced by older versions of rmp-serde.

source

pub fn with_binary(self) -> Serializer<W, BinaryConfig<C>>

Consumes this serializer returning the new one, which will serialize types as binary (Serializer::is_human_readable will return false).

This is the default MessagePack serialization mechanism, emitting the most compact representation.

source

pub fn with_bytes(self, mode: BytesMode) -> Serializer<W, C>

Prefer encoding sequences of u8 as bytes, rather than as a sequence of variable-size integers.

This reduces overhead of binary data, but it may break decodnig of some Serde types that happen to contain [u8]s, but don’t implement Serde’s visit_bytes.

use serde::ser::Serialize;
let mut msgpack_data = Vec::new();
let mut serializer = rmp_serde::Serializer::new(&mut msgpack_data)
    .with_bytes(rmp_serde::config::BytesMode::ForceAll);
vec![255u8; 100].serialize(&mut serializer).unwrap();

Trait Implementations§

source§

impl<W: Debug, C: Debug> Debug for Serializer<W, C>

source§

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

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

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

§

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

The error type when some error occurs during serialization.
§

type SerializeSeq = MaybeUnknownLengthCompound<'a, W, C>

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

type SerializeTuple = Tuple<'a, W, C>

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

type SerializeTupleStruct = Compound<'a, W, C>

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

type SerializeTupleVariant = Compound<'a, W, C>

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

type SerializeMap = MaybeUnknownLengthCompound<'a, W, C>

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

type SerializeStruct = Compound<'a, W, C>

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

type SerializeStructVariant = Compound<'a, W, C>

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

fn is_human_readable(&self) -> bool

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

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

Serialize a bool value. Read more
source§

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

Serialize an i8 value. Read more
source§

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

Serialize an i16 value. Read more
source§

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

Serialize an i32 value. Read more
source§

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

Serialize an i64 value. Read more
source§

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

Serialize an i128 value. Read more
source§

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

Serialize a u8 value. Read more
source§

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

Serialize a u16 value. Read more
source§

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

Serialize a u32 value. Read more
source§

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

Serialize a u64 value. Read more
source§

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

Serialize a u128 value. Read more
source§

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

Serialize an f32 value. Read more
source§

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

Serialize an f64 value. Read more
source§

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

Serialize a character. Read more
source§

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

Serialize a &str. Read more
source§

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

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

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

Serialize a None value. Read more
source§

fn serialize_some<T: ?Sized + Serialize>(self, v: &T) -> Result<(), Self::Error>

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

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

Serialize a () value. Read more
source§

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

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

fn serialize_unit_variant( self, _name: &str, _: u32, variant: &'static str, ) -> Result<Self::Ok, Self::Error>

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

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

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

fn serialize_newtype_variant<T: ?Sized + Serialize>( self, _name: &'static str, _: u32, variant: &'static str, value: &T, ) -> Result<Self::Ok, Self::Error>

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

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

fn serialize_tuple( self, len: usize, ) -> Result<Self::SerializeTuple, Self::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<Self::SerializeTupleStruct, Self::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, _: 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. Read more
source§

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

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

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

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
source§

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

impl<W: Write, C> UnderlyingWrite for Serializer<W, C>

§

type Write = W

Underlying writer type.
source§

fn get_ref(&self) -> &Self::Write

Gets a reference to the underlying writer.
source§

fn get_mut(&mut self) -> &mut Self::Write

Gets a mutable reference to the underlying writer. Read more
source§

fn into_inner(self) -> Self::Write

Unwraps this Serializer, returning the underlying writer.

Auto Trait Implementations§

§

impl<W, C> Freeze for Serializer<W, C>
where W: Freeze,

§

impl<W, C> RefUnwindSafe for Serializer<W, C>

§

impl<W, C> Send for Serializer<W, C>
where W: Send, C: Send,

§

impl<W, C> Sync for Serializer<W, C>
where W: Sync, C: Sync,

§

impl<W, C> Unpin for Serializer<W, C>
where W: Unpin, C: Unpin,

§

impl<W, C> UnwindSafe for Serializer<W, C>
where W: UnwindSafe, C: UnwindSafe,

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.