Struct ssh_format::Serializer

pub struct Serializer<T: SerBacker = Vec<u8>> { /* private fields */ }

Implementations

impl<T: SerBacker> Serializer<T>

pub fn new() -> Self

pub fn reserve(&mut self, additional: usize)

pub fn get_output(&mut self) -> Result<&mut T>

Return a byte array with the first 4 bytes representing the size of the rest of the serialized message.

pub fn get_output_with_data(&mut self, len: u32) -> Result<&mut T>

Return a byte array with the first 4 bytes representing the size of the rest of the serialized message.

• len - length of additional data included in the packet.

pub fn reset(&mut self)

Clear the output but preserve its allocated memory

Trait Implementations

impl<T: Clone + SerBacker> Clone for Serializer<T>

fn clone(&self) -> Serializer<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + SerBacker> Debug for Serializer<T>

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

Formats the value using the given formatter.

impl Default for Serializer

fn default() -> Self

Returns the “default value” for a type.

impl<'a, Container: SerBacker> SerializeMap for &'a mut Serializer<Container>

Unsupported

fn serialize_key<T>(&mut self, _key: &T) -> Result<()>

where T: ?Sized + Serialize,

Unsupported

fn serialize_value<T>(&mut self, _value: &T) -> Result<()>

where T: ?Sized + Serialize,

Unsupported

fn end(self) -> Result<()>

Unsupported

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

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<'a, Container: SerBacker> SerializeSeq for &'a mut Serializer<Container>

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>(&mut self, value: &T) -> Result<()>

where T: ?Sized + Serialize,

Serialize a sequence element.

fn end(self) -> Result<()>

Finish serializing a sequence.

impl<'a, Container: SerBacker> SerializeStruct for &'a mut Serializer<Container>

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>(&mut self, _key: &'static str, value: &T) -> Result<()>

where T: ?Sized + Serialize,

Serialize a struct field.

fn end(self) -> Result<()>

Finish serializing a struct.

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

Indicate that a struct field has been skipped.

impl<'a, Container: SerBacker> SerializeStructVariant for &'a mut Serializer<Container>

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>(&mut self, key: &'static str, value: &T) -> Result<()>

where T: ?Sized + Serialize,

Serialize a struct variant field.

fn end(self) -> Result<()>

Finish serializing a struct variant.

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

Indicate that a struct variant field has been skipped.

impl<'a, Container: SerBacker> SerializeTuple for &'a mut Serializer<Container>

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>(&mut self, value: &T) -> Result<()>

where T: ?Sized + Serialize,

Serialize a tuple element.

fn end(self) -> Result<()>

Finish serializing a tuple.

impl<'a, Container: SerBacker> SerializeTupleStruct for &'a mut Serializer<Container>

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>(&mut self, value: &T) -> Result<()>

where T: ?Sized + Serialize,

Serialize a tuple struct field.

fn end(self) -> Result<()>

Finish serializing a tuple struct.

impl<'a, Container: SerBacker> SerializeTupleVariant for &'a mut Serializer<Container>

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>(&mut self, value: &T) -> Result<()>

where T: ?Sized + Serialize,

Serialize a tuple variant field.

fn end(self) -> Result<()>

Finish serializing a tuple variant.

impl<'a, Container: SerBacker> Serializer for &'a mut Serializer<Container>

fn serialize_map(self, _len: Option<usize>) -> Result<Self::SerializeMap>

Unsupported

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 = &'a mut Serializer<Container>

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

type SerializeTuple = &'a mut Serializer<Container>

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

type SerializeTupleStruct = &'a mut Serializer<Container>

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

type SerializeTupleVariant = &'a mut Serializer<Container>

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

type SerializeMap = &'a mut Serializer<Container>

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

type SerializeStruct = &'a mut Serializer<Container>

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

type SerializeStructVariant = &'a mut Serializer<Container>

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

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

Serialize a bool value.

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

Serialize a u8 value.

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

Serialize an i8 value.

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

Serialize an i16 value.

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

Serialize an i32 value.

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

Serialize an i64 value.

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

Serialize a u16 value.

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

Serialize a u32 value.

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

Serialize a u64 value.

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

Serialize an f32 value.

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

Serialize an f64 value.

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

Serialize a character.

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

Serialize a &str.

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

Serialize a chunk of raw byte data.

fn serialize_none(self) -> Result<()>

Serialize a None value.

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

where T: ?Sized + Serialize,

Serialize a Some(T) value.

fn serialize_unit(self) -> Result<()>

Serialize a () value.

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

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

fn serialize_newtype_struct<T>( self, _name: &'static str, value: &T, ) -> Result<()>

where T: ?Sized + Serialize,

Serialize a newtype struct like struct Millimeters(u8).

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

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>

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>

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_struct( self, _name: &'static str, len: usize, ) -> Result<Self::SerializeStruct>

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_unit_variant( self, _name: &'static str, variant_index: u32, _variant: &'static str, ) -> Result<()>

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

fn serialize_newtype_variant<T>( self, name: &'static str, variant_index: u32, variant: &'static str, value: &T, ) -> Result<()>

where T: ?Sized + Serialize,

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

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

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_struct_variant( self, name: &'static str, variant_index: u32, variant: &'static str, len: usize, ) -> Result<Self::SerializeStructVariant>

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 serialize_i128(self, v: i128) -> Result<Self::Ok, Self::Error>

Serialize an i128 value.

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

Serialize a u128 value.

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.

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.

fn is_human_readable(&self) -> bool

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