Trait ssz::Encode

pub trait Encode {
    fn is_ssz_fixed_len() -> bool;
    fn ssz_append(&self, buf: &mut Vec<u8>);

    fn ssz_fixed_len() -> usize { ... }
    fn as_ssz_bytes(&self) -> Vec<u8> { ... }
}

Provides SSZ encoding (serialization) via the as_ssz_bytes(&self) method.

See examples/ for manual implementations or the crate root for implementations using #[derive(Encode)].

Required methods

fn is_ssz_fixed_len() -> bool

Returns true if this object has a fixed-length.

I.e., there are no variable length items in this object or any of it's contained objects.

fn ssz_append(&self, buf: &mut Vec<u8>)

Append the encoding self to buf.

Note, variable length objects need only to append their "variable length" portion, they do not need to provide their offset.

Loading content...

Provided methods

fn ssz_fixed_len() -> usize

The number of bytes this object occupies in the fixed-length portion of the SSZ bytes.

By default, this is set to BYTES_PER_LENGTH_OFFSET which is suitable for variable length objects, but not fixed-length objects. Fixed-length objects must return a value which represents their length.

fn as_ssz_bytes(&self) -> Vec<u8>

Returns the full-form encoding of this object.

The default implementation of this method should suffice for most cases.

Loading content...

Implementations on Foreign Types

impl Encode for u8

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

impl Encode for u16

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

impl Encode for u32

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

impl Encode for u64

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

impl Encode for usize

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

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

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

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

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

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

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

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

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

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

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

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

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

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

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

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

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

impl<A: Encode, B: Encode, C: Encode, D: Encode, E: Encode, F: Encode, G: Encode, H: Encode, I: Encode, J: Encode> Encode for (A, B, C, D, E, F, G, H, I, J)

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

impl<A: Encode, B: Encode, C: Encode, D: Encode, E: Encode, F: Encode, G: Encode, H: Encode, I: Encode, J: Encode, K: Encode> Encode for (A, B, C, D, E, F, G, H, I, J, K)

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

impl<A: Encode, B: Encode, C: Encode, D: Encode, E: Encode, F: Encode, G: Encode, H: Encode, I: Encode, J: Encode, K: Encode, L: Encode> Encode for (A, B, C, D, E, F, G, H, I, J, K, L)

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

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

The SSZ "union" type.

fn is_ssz_fixed_len() -> bool

fn ssz_append(&self, buf: &mut Vec<u8>)

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

fn is_ssz_fixed_len() -> bool

fn ssz_append(&self, buf: &mut Vec<u8>)

impl Encode for bool

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

impl Encode for NonZeroUsize

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

impl Encode for H256

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

impl Encode for U256

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

impl Encode for U128

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

impl Encode for [u8; 4]

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

impl Encode for [u8; 32]

fn is_ssz_fixed_len() -> bool

fn ssz_fixed_len() -> usize

fn ssz_append(&self, buf: &mut Vec<u8>)

Loading content...

Implementors

Loading content...