Trait ed::Encode

pub trait Encode {
    fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>;
    fn encoding_length(&self) -> Result<usize>;

    fn encode(&self) -> Result<Vec<u8>> { ... }
}

A trait for values that can be encoded into bytes deterministically.

Required methods

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Writes the encoded representation of the value to the destination writer. Can error due to either a write error from dest, or an encoding error for types where invalid values are possible.

It may be more convenient to call encode which returns bytes, however encode_into will often be more efficient since it can write the encoding without necessarily allocating a new Vec<u8>.

fn encoding_length(&self) -> Result<usize>

Calculates the length of the encoding for this value. Can error for types where invalid values are possible.

Loading content...

Provided methods

fn encode(&self) -> Result<Vec<u8>>

Returns the encoded representation of the value as a Vec<u8>.

While this method is convenient, it will often be more efficient to call encode_into since encode usually involves allocating a new Vec<u8>.

Loading content...

Implementations on Foreign Types

impl Encode for u8

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the integer as fixed-size big-endian bytes.

fn encoding_length(&self) -> Result<usize>

Returns the size of the integer in bytes. Will always return an Ok result.

impl Encode for u16

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the integer as fixed-size big-endian bytes.

fn encoding_length(&self) -> Result<usize>

Returns the size of the integer in bytes. Will always return an Ok result.

impl Encode for u32

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the integer as fixed-size big-endian bytes.

fn encoding_length(&self) -> Result<usize>

Returns the size of the integer in bytes. Will always return an Ok result.

impl Encode for u64

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the integer as fixed-size big-endian bytes.

fn encoding_length(&self) -> Result<usize>

Returns the size of the integer in bytes. Will always return an Ok result.

impl Encode for u128

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the integer as fixed-size big-endian bytes.

fn encoding_length(&self) -> Result<usize>

Returns the size of the integer in bytes. Will always return an Ok result.

impl Encode for i8

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the integer as fixed-size big-endian bytes.

fn encoding_length(&self) -> Result<usize>

Returns the size of the integer in bytes. Will always return an Ok result.

impl Encode for i16

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the integer as fixed-size big-endian bytes.

fn encoding_length(&self) -> Result<usize>

Returns the size of the integer in bytes. Will always return an Ok result.

impl Encode for i32

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the integer as fixed-size big-endian bytes.

fn encoding_length(&self) -> Result<usize>

Returns the size of the integer in bytes. Will always return an Ok result.

impl Encode for i64

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the integer as fixed-size big-endian bytes.

fn encoding_length(&self) -> Result<usize>

Returns the size of the integer in bytes. Will always return an Ok result.

impl Encode for i128

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the integer as fixed-size big-endian bytes.

fn encoding_length(&self) -> Result<usize>

Returns the size of the integer in bytes. Will always return an Ok result.

impl Encode for bool

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the boolean as a single byte: 0 for false or 1 for true.

fn encoding_length(&self) -> Result<usize>

Always returns Ok(1).

impl<T: Encode> Encode for Option<T>

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes as a 0 byte for None, or as a 1 byte followed by the encoding of the inner value for Some.

fn encoding_length(&self) -> Result<usize>

Length will be 1 for None, or 1 plus the encoding length of the inner value for Some.

impl Encode for ()

fn encode_into<W: Write>(&self, _: &mut W) -> Result<()>

Encoding a unit tuple is a no-op.

fn encoding_length(&self) -> Result<usize>

Always returns Ok(0).

impl<A: Encode> Encode for (A,)

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the fields of the tuple one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of the fields of the tuple.

impl<A: Encode + Terminated, B: Encode> Encode for (A, B)

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the fields of the tuple one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of the fields of the tuple.

impl<A: Encode + Terminated, B: Encode + Terminated, C: Encode> Encode for (A, B, C)

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the fields of the tuple one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of the fields of the tuple.

impl<A: Encode + Terminated, B: Encode + Terminated, C: Encode + Terminated, D: Encode> Encode for (A, B, C, D)

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the fields of the tuple one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of the fields of the tuple.

impl<A: Encode + Terminated, B: Encode + Terminated, C: Encode + Terminated, D: Encode + Terminated, E: Encode> Encode for (A, B, C, D, E)

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the fields of the tuple one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of the fields of the tuple.

impl<A: Encode + Terminated, B: Encode + Terminated, C: Encode + Terminated, D: Encode + Terminated, E: Encode + Terminated, F: Encode> Encode for (A, B, C, D, E, F)

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the fields of the tuple one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of the fields of the tuple.

impl<A: Encode + Terminated, B: Encode + Terminated, C: Encode + Terminated, D: Encode + Terminated, E: Encode + Terminated, F: Encode + Terminated, G: Encode> Encode for (A, B, C, D, E, F, G)

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the fields of the tuple one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of the fields of the tuple.

impl<T: Encode + Terminated> Encode for [T; 0]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 1]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 2]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 3]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 4]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 5]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 6]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 7]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 8]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 9]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 10]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 11]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 12]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 13]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 14]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 15]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 16]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 17]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 18]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 19]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 20]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 21]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 22]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 23]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 24]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 25]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 26]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 27]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 28]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 29]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 30]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 31]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 32]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 33]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 64]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 128]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T; 256]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the array one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for Vec<T>

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the vector one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode + Terminated> Encode for [T]

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the elements of the slice one after another, in order.

fn encoding_length(&self) -> Result<usize>

Returns the sum of the encoding lengths of all elements.

impl<T: Encode> Encode for Box<T>

fn encode_into<W: Write>(&self, dest: &mut W) -> Result<()>

Encodes the inner value.

fn encoding_length(&self) -> Result<usize>

Returns the encoding length of the inner value.

Loading content...

Implementors

Loading content...