Struct dusk_tlv::TlvWriter

[+] Show declaration

pub struct TlvWriter<W> where
    W: Write,  { /* fields omitted */ }

[−] Expand description

Optionally consumes an implementation of io::Write, and provides an adapter to convert slices of bytes to TLV format, and output the result to the writer.

Methods

impl<W> TlvWriter<W> where
    W: Write, [−]

pub fn new(writer: W) -> Self[−]

TlvWriter constructor

pub fn into_inner(self) -> W[−]

Consumes self, and return the inner writer

pub fn bytes_len_to_writer(writer: W, len: usize) -> Result<usize, Error>[−]

Convert the provided slice of bytes to TLV format, and write the TL to the writer

pub fn bytes_to_writer(writer: W, buf: &[u8]) -> Result<usize, Error>[−]

Convert the provided slice of bytes to TLV format, output the result to the provided writer, and return the amount of bytes written.

pub fn write_usize(&mut self, n: usize) -> Result<usize, Error>[−]

Append the provided usize to the writer in TLV format

pub fn write_list<L: AsRef<[u8]>>(&mut self, list: &[L]) -> Result<usize, Error>[−]

Write a list of serializable items

Trait Implementations

impl<W> Write for TlvWriter<W> where
    W: Write, [+]

[+] Show hidden undocumented items

fn write(&mut self, buf: &[u8]) -> Result<usize, Error>[−]

The io::Write::write implementation will internally call the TlvWriter::bytes_to_writer. Therefore, the provided buffer will first be converted to TLV format, and then sent to the inner writer.

fn flush(&mut self) -> Result<(), Error>[−]

The io::Write::flush implementation will just forward the call to the inner writer.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>[−]

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>[−]

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>[−]

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self[−]

Creates a "by reference" adaptor for this instance of Write.

impl<'a, W> SerializeTuple for &'a mut TlvWriter<W> where
    W: Write, [+]

[+] Show hidden undocumented items

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<(), Self::Error> where
    T: Serialize, [−]

Serialize a tuple element.

fn end(self) -> Result<Self::Ok, Self::Error>[−]

Finish serializing a tuple.

impl<'a, W> Serializer for &'a mut TlvWriter<W> where
    W: Write, [+]

[+] Show hidden undocumented items

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

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

type SerializeTuple = Self

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

type SerializeTupleStruct = Self

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

type SerializeTupleVariant = Self

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

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

type SerializeStructVariant = Self

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

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

Serialize a bool value.

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

Serialize an i8 value.

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

Serialize an i16 value.

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

Serialize an i32 value.

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

Serialize an i64 value.

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

Serialize a u8 value.

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

Serialize a u16 value.

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

Serialize a u32 value.

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

Serialize a u64 value.

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

Serialize an f32 value.

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

Serialize an f64 value.

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

Serialize a character.

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

Serialize a &str.

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

Serialize a chunk of raw byte data.

fn serialize_none(self) -> Result<Self::Ok, Self::Error>[−]

Serialize a [None] value.

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

Serialize a [Some(T)] value.

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

Serialize a () value.

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

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

fn serialize_unit_variant(
    self,
    _name: &'static str,
    _variant_index: u32,
    _variant: &'static str
) -> Result<Self::Ok, Self::Error>[−]

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

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

Serialize a newtype struct like struct Millimeters(u8).

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

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

fn serialize_seq(
    self,
    len: Option<usize>
) -> Result<Self::SerializeSeq, Self::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.

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.

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.

fn serialize_tuple_variant(
    self,
    _name: &'static str,
    _variant_index: u32,
    _variant: &'static str,
    len: usize
) -> Result<Self::SerializeTupleVariant, Self::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.

fn serialize_map(
    self,
    len: Option<usize>
) -> Result<Self::SerializeMap, Self::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.

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.

fn serialize_struct_variant(
    self,
    _name: &'static str,
    _variant_index: u32,
    _variant: &'static str,
    len: usize
) -> Result<Self::SerializeStructVariant, Self::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.

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
    I: IntoIterator<Item = (K, V)>,
    K: Serialize,
    V: Serialize, [−]

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.

impl<'a, W> SerializeMap for &'a mut TlvWriter<W> where
    W: Write, [+]

[+] Show hidden undocumented items

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, _value: &T) -> Result<(), Self::Error> where
    T: Serialize, [−]

Serialize a map key.

fn serialize_value<T: ?Sized>(&mut self, _value: &T) -> Result<(), Self::Error> where
    T: Serialize, [−]

Serialize a map value.

fn end(self) -> Result<Self::Ok, Self::Error>[−]

Finish serializing a map.

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, '_, W> SerializeSeq for &'_ mut TlvWriter<W> where
    W: Write, [+]

[+] Show hidden undocumented items

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<(), Self::Error> where
    T: Serialize, [−]

Serialize a sequence element.

fn end(self) -> Result<Self::Ok, Self::Error>[−]

Finish serializing a sequence.

impl<'a, W> SerializeStruct for &'a mut TlvWriter<W> where
    W: Write, [+]

[+] Show hidden undocumented items

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<(), Self::Error> where
    T: Serialize, [−]

Serialize a struct field.

fn end(self) -> Result<Self::Ok, Self::Error>[−]

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, W> SerializeStructVariant for &'a mut TlvWriter<W> where
    W: Write, [+]

[+] Show hidden undocumented items

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<(), Self::Error> where
    T: Serialize, [−]

Serialize a struct variant field.

fn end(self) -> Result<Self::Ok, Self::Error>[−]

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, W> SerializeTupleStruct for &'a mut TlvWriter<W> where
    W: Write, [+]

[+] Show hidden undocumented items

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<(), Self::Error> where
    T: Serialize, [−]

Serialize a tuple struct field.

fn end(self) -> Result<Self::Ok, Self::Error>[−]

Finish serializing a tuple struct.

impl<'a, W> SerializeTupleVariant for &'a mut TlvWriter<W> where
    W: Write, [+]

[+] Show hidden undocumented items

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<(), Self::Error> where
    T: Serialize, [−]

Serialize a tuple variant field.

fn end(self) -> Result<Self::Ok, Self::Error>[−]

Finish serializing a tuple variant.