Struct bytecodec::tuple::TupleEncoder

pub struct TupleEncoder<E> { /* fields omitted */ }

Encoder for tuples.

Methods

impl<E> TupleEncoder<E>

pub fn new(inner: E) -> Self

Makes a new TupleEncoder.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn inner_ref(&self) -> &E

Returns a reference to the inner encoders.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn inner_mut(&mut self) -> &mut E

Returns a mutable reference to the inner encoders.

pub fn into_inner(self) -> E

Takes ownership of this instance and returns the inner encoders.

Trait Implementations

impl<E: Debug> Debug for TupleEncoder<E>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<E: Default> Default for TupleEncoder<E>

fn default() -> TupleEncoder<E>

Returns the "default value" for a type.

impl<E0, E1> Encode for TupleEncoder<(E0, E1)> where
    E0: Encode,
    E1: Encode, 

type Item = (E0::Item, E1::Item)

The type of items to be encoded.

fn encode(&mut self, buf: &mut [u8], eos: Eos) -> Result<usize>

Encodes the items in the encoder and writes the encoded bytes to the given buffer.

fn start_encoding(&mut self, t: Self::Item) -> Result<()>

Tries to start encoding the given item.

fn requiring_bytes(&self) -> ByteCount

Returns the number of bytes required to encode all the items in the encoder.

fn is_idle(&self) -> bool

Returns true if there are no items to be encoded in the encoder, otherwise false.

impl<E0, E1> SizedEncode for TupleEncoder<(E0, E1)> where
    E0: SizedEncode,
    E1: SizedEncode, 

fn exact_requiring_bytes(&self) -> u64

Returns the exact number of bytes required to encode all the items remaining in the encoder.

impl<E0, E1, E2> Encode for TupleEncoder<(E0, E1, E2)> where
    E0: Encode,
    E1: Encode,
    E2: Encode, 

type Item = (E0::Item, E1::Item, E2::Item)

The type of items to be encoded.

fn encode(&mut self, buf: &mut [u8], eos: Eos) -> Result<usize>

Encodes the items in the encoder and writes the encoded bytes to the given buffer.

fn start_encoding(&mut self, t: Self::Item) -> Result<()>

Tries to start encoding the given item.

fn requiring_bytes(&self) -> ByteCount

Returns the number of bytes required to encode all the items in the encoder.

fn is_idle(&self) -> bool

Returns true if there are no items to be encoded in the encoder, otherwise false.

impl<E0, E1, E2> SizedEncode for TupleEncoder<(E0, E1, E2)> where
    E0: SizedEncode,
    E1: SizedEncode,
    E2: SizedEncode, 

fn exact_requiring_bytes(&self) -> u64

Returns the exact number of bytes required to encode all the items remaining in the encoder.

impl<E0, E1, E2, E3> Encode for TupleEncoder<(E0, E1, E2, E3)> where
    E0: Encode,
    E1: Encode,
    E2: Encode,
    E3: Encode, 

type Item = (E0::Item, E1::Item, E2::Item, E3::Item)

The type of items to be encoded.

fn encode(&mut self, buf: &mut [u8], eos: Eos) -> Result<usize>

Encodes the items in the encoder and writes the encoded bytes to the given buffer.

fn start_encoding(&mut self, t: Self::Item) -> Result<()>

Tries to start encoding the given item.

fn requiring_bytes(&self) -> ByteCount

Returns the number of bytes required to encode all the items in the encoder.

fn is_idle(&self) -> bool

Returns true if there are no items to be encoded in the encoder, otherwise false.

impl<E0, E1, E2, E3> SizedEncode for TupleEncoder<(E0, E1, E2, E3)> where
    E0: SizedEncode,
    E1: SizedEncode,
    E2: SizedEncode,
    E3: SizedEncode, 

fn exact_requiring_bytes(&self) -> u64

Returns the exact number of bytes required to encode all the items remaining in the encoder.

impl<E0, E1, E2, E3, E4> Encode for TupleEncoder<(E0, E1, E2, E3, E4)> where
    E0: Encode,
    E1: Encode,
    E2: Encode,
    E3: Encode,
    E4: Encode, 

type Item = (E0::Item, E1::Item, E2::Item, E3::Item, E4::Item)

The type of items to be encoded.

fn encode(&mut self, buf: &mut [u8], eos: Eos) -> Result<usize>

Encodes the items in the encoder and writes the encoded bytes to the given buffer.

fn start_encoding(&mut self, t: Self::Item) -> Result<()>

Tries to start encoding the given item.

fn requiring_bytes(&self) -> ByteCount

Returns the number of bytes required to encode all the items in the encoder.

fn is_idle(&self) -> bool

Returns true if there are no items to be encoded in the encoder, otherwise false.

impl<E0, E1, E2, E3, E4> SizedEncode for TupleEncoder<(E0, E1, E2, E3, E4)> where
    E0: SizedEncode,
    E1: SizedEncode,
    E2: SizedEncode,
    E3: SizedEncode,
    E4: SizedEncode, 

fn exact_requiring_bytes(&self) -> u64

Returns the exact number of bytes required to encode all the items remaining in the encoder.

impl<E0, E1, E2, E3, E4, E5> Encode for TupleEncoder<(E0, E1, E2, E3, E4, E5)> where
    E0: Encode,
    E1: Encode,
    E2: Encode,
    E3: Encode,
    E4: Encode,
    E5: Encode, 

type Item = (E0::Item, E1::Item, E2::Item, E3::Item, E4::Item, E5::Item)

The type of items to be encoded.

fn encode(&mut self, buf: &mut [u8], eos: Eos) -> Result<usize>

Encodes the items in the encoder and writes the encoded bytes to the given buffer.

fn start_encoding(&mut self, t: Self::Item) -> Result<()>

Tries to start encoding the given item.

fn requiring_bytes(&self) -> ByteCount

Returns the number of bytes required to encode all the items in the encoder.

fn is_idle(&self) -> bool

Returns true if there are no items to be encoded in the encoder, otherwise false.

impl<E0, E1, E2, E3, E4, E5> SizedEncode for TupleEncoder<(E0, E1, E2, E3, E4, E5)> where
    E0: SizedEncode,
    E1: SizedEncode,
    E2: SizedEncode,
    E3: SizedEncode,
    E4: SizedEncode,
    E5: SizedEncode, 

fn exact_requiring_bytes(&self) -> u64

Returns the exact number of bytes required to encode all the items remaining in the encoder.

impl<E0, E1, E2, E3, E4, E5, E6> Encode for TupleEncoder<(E0, E1, E2, E3, E4, E5, E6)> where
    E0: Encode,
    E1: Encode,
    E2: Encode,
    E3: Encode,
    E4: Encode,
    E5: Encode,
    E6: Encode, 

type Item = (E0::Item, E1::Item, E2::Item, E3::Item, E4::Item, E5::Item, E6::Item)

The type of items to be encoded.

fn encode(&mut self, buf: &mut [u8], eos: Eos) -> Result<usize>

Encodes the items in the encoder and writes the encoded bytes to the given buffer.

fn start_encoding(&mut self, t: Self::Item) -> Result<()>

Tries to start encoding the given item.

fn requiring_bytes(&self) -> ByteCount

Returns the number of bytes required to encode all the items in the encoder.

fn is_idle(&self) -> bool

Returns true if there are no items to be encoded in the encoder, otherwise false.

impl<E0, E1, E2, E3, E4, E5, E6> SizedEncode for TupleEncoder<(E0, E1, E2, E3, E4, E5, E6)> where
    E0: SizedEncode,
    E1: SizedEncode,
    E2: SizedEncode,
    E3: SizedEncode,
    E4: SizedEncode,
    E5: SizedEncode,
    E6: SizedEncode, 

fn exact_requiring_bytes(&self) -> u64

Returns the exact number of bytes required to encode all the items remaining in the encoder.

impl<E0, E1, E2, E3, E4, E5, E6, E7> Encode for TupleEncoder<(E0, E1, E2, E3, E4, E5, E6, E7)> where
    E0: Encode,
    E1: Encode,
    E2: Encode,
    E3: Encode,
    E4: Encode,
    E5: Encode,
    E6: Encode,
    E7: Encode, 

type Item = (E0::Item, E1::Item, E2::Item, E3::Item, E4::Item, E5::Item, E6::Item, E7::Item)

The type of items to be encoded.

fn encode(&mut self, buf: &mut [u8], eos: Eos) -> Result<usize>

Encodes the items in the encoder and writes the encoded bytes to the given buffer.

fn start_encoding(&mut self, t: Self::Item) -> Result<()>

Tries to start encoding the given item.

fn requiring_bytes(&self) -> ByteCount

Returns the number of bytes required to encode all the items in the encoder.

fn is_idle(&self) -> bool

Returns true if there are no items to be encoded in the encoder, otherwise false.

impl<E0, E1, E2, E3, E4, E5, E6, E7> SizedEncode for TupleEncoder<(E0, E1, E2, E3, E4, E5, E6, E7)> where
    E0: SizedEncode,
    E1: SizedEncode,
    E2: SizedEncode,
    E3: SizedEncode,
    E4: SizedEncode,
    E5: SizedEncode,
    E6: SizedEncode,
    E7: SizedEncode, 

fn exact_requiring_bytes(&self) -> u64

Returns the exact number of bytes required to encode all the items remaining in the encoder.