Struct Encoder 

pub struct Encoder<'a> { /* private fields */ }

Struct encoding helper

Used to encode a struct into RLP format. The struct’s fields must implement RLPEncode. The struct is encoded as a list, with its values being the fields in the order they are passed to Encoder::encode_field.

Examples

#[derive(Debug, PartialEq, Eq)]
struct Simple {
    pub a: u8,
    pub b: u16,
}

impl RLPEncode for Simple {
    fn encode(&self, buf: &mut dyn BufMut) {
        // The fields are encoded in the order given here
        Encoder::new(buf)
            .encode_field(&self.a)
            .encode_field(&self.b)
            .finish();
    }
}

let mut buf = vec![];
Simple { a: 61, b: 75 }.encode(&mut buf);

assert_eq!(&buf, &[0xc2, 61, 75]);

Implementations

impl<'a> Encoder<'a>

pub fn new(buf: &'a mut dyn BufMut) -> Self

Creates a new encoder that writes to the given buffer.

pub fn encode_field<T: RLPEncode>(self, value: &T) -> Self

Stores a field to be encoded.

pub fn encode_optional_field<T: RLPEncode>(self, opt_value: &Option<T>) -> Self

If Some, stores a field to be encoded, else does nothing.

pub fn encode_key_value_list<T: RLPEncode>( self, list: &Vec<(Bytes, Bytes)>, ) -> Self

Stores a (key, value) list where the values are already encoded (i.e. value = RLP prefix || payload) but the keys are not encoded

pub fn finish(self)

Finishes encoding the struct and writes the result to the buffer.

pub fn encode_raw(self, value: &[u8]) -> Self

Adds a raw value to the buffer without rlp-encoding it

pub fn encode_bytes(self, value: &[u8]) -> Self

Stores a field to be encoded as bytes This method is used to bypass the conflicting implementations between Vec and Vec

Trait Implementations

impl Debug for Encoder<'_>

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

Formats the value using the given formatter.