Trait frame_support::pallet_prelude::Encode

source ·

pub trait Encode {
    // Provided methods
    fn size_hint(&self) -> usize { ... }
    fn encode_to<T>(&self, dest: &mut T)
       where T: Output + ?Sized { ... }
    fn encode(&self) -> Vec<u8, Global> ⓘ { ... }
    fn using_encoded<R, F>(&self, f: F) -> R
       where F: FnOnce(&[u8]) -> R { ... }
    fn encoded_size(&self) -> usize { ... }
}

Expand description

Trait that allows zero-copy write of value-references to slices in LE format.

Implementations should override using_encoded for value types and encode_to and size_hint for allocating types. Wrapper types should override all methods.

Provided Methods§

source

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

This method is used inside default implementation of encode to avoid re-allocations.

source

fn encode_to<T>(&self, dest: &mut T)where T: Output + ?Sized,

Convert self to a slice and append it to the destination.

source

fn encode(&self) -> Vec<u8, Global> ⓘ

Convert self to an owned vector.

source

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

source

fn encoded_size(&self) -> usize

Calculates the encoded size.

Should be used when the encoded data isn’t required.

This works by using a special Output that only tracks the size. So, there are no allocations inside the output. However, this can not prevent allocations that some types are doing inside their own encoding.

Trait frame_support::pallet_prelude::Encode

Provided Methods§

fn size_hint(&self) -> usize

fn encode_to<T>(&self, dest: &mut T)where T: Output + ?Sized,

fn encode(&self) -> Vec<u8, Global> ⓘ

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

fn encoded_size(&self) -> usize

Note

Implementations on Foreign Types§

impl Encode for u64

fn size_hint(&self) -> usize

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

impl Encode for i128

fn size_hint(&self) -> usize

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

impl<M0, N0, O0, P0, Q0, R0> Encode for (M0, N0, O0, P0, Q0, R0)where M0: Encode, N0: Encode, O0: Encode, P0: Encode, Q0: Encode, R0: Encode,

fn size_hint(&self) -> usize

fn encode_to<T>(&self, dest: &mut T)where T: Output + ?Sized,

impl<I0, J0, K0, L0, M0, N0, O0, P0, Q0, R0> Encode for (I0, J0, K0, L0, M0, N0, O0, P0, Q0, R0)where I0: Encode, J0: Encode, K0: Encode, L0: Encode, M0: Encode, N0: Encode, O0: Encode, P0: Encode, Q0: Encode, R0: Encode,

fn size_hint(&self) -> usize

fn encode_to<T>(&self, dest: &mut T)where T: Output + ?Sized,

impl Encode for NonZeroU16

fn size_hint(&self) -> usize

fn encode_to<W>(&self, dest: &mut W)where W: Output + ?Sized,

fn encode(&self) -> Vec<u8, Global> ⓘ

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

impl Encode for i64

fn size_hint(&self) -> usize

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

impl<T> Encode for BTreeSet<T, Global>where T: Encode,

fn size_hint(&self) -> usize

fn encode_to<W>(&self, dest: &mut W)where W: Output + ?Sized,

fn size_hint(&self) -> usize

fn encode_to<T>(&self, dest: &mut T)where T: Output + ?Sized,

impl Encode for bool

fn size_hint(&self) -> usize

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

impl<K, V> Encode for BTreeMap<K, V, Global>where K: Encode, V: Encode,

fn size_hint(&self) -> usize

fn encode_to<W>(&self, dest: &mut W)where W: Output + ?Sized,

impl Encode for u8

fn size_hint(&self) -> usize

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

fn size_hint(&self) -> usize

fn encode_to<T>(&self, dest: &mut T)where T: Output + ?Sized,

impl Encode for Duration

fn size_hint(&self) -> usize

fn encode(&self) -> Vec<u8, Global> ⓘ

impl<K0, L0, M0, N0, O0, P0, Q0, R0> Encode for (K0, L0, M0, N0, O0, P0, Q0, R0)where K0: Encode, L0: Encode, M0: Encode, N0: Encode, O0: Encode, P0: Encode, Q0: Encode, R0: Encode,

fn size_hint(&self) -> usize

fn encode_to<T>(&self, dest: &mut T)where T: Output + ?Sized,

impl Encode for u32

fn size_hint(&self) -> usize

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

impl Encode for f32

fn size_hint(&self) -> usize

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

impl<Q0, R0> Encode for (Q0, R0)where Q0: Encode, R0: Encode,

fn size_hint(&self) -> usize

fn encode_to<T>(&self, dest: &mut T)where T: Output + ?Sized,

impl<G0, H0, I0, J0, K0, L0, M0, N0, O0, P0, Q0, R0> Encode for (G0, H0, I0, J0, K0, L0, M0, N0, O0, P0, Q0, R0)where G0: Encode, H0: Encode, I0: Encode, J0: Encode, K0: Encode, L0: Encode, M0: Encode, N0: Encode, O0: Encode, P0: Encode, Q0: Encode, R0: Encode,

fn size_hint(&self) -> usize

fn encode_to<T>(&self, dest: &mut T)where T: Output + ?Sized,

impl Encode for i8

fn size_hint(&self) -> usize

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

impl<F0, G0, H0, I0, J0, K0, L0, M0, N0, O0, P0, Q0, R0> Encode for (F0, G0, H0, I0, J0, K0, L0, M0, N0, O0, P0, Q0, R0)where F0: Encode, G0: Encode, H0: Encode, I0: Encode, J0: Encode, K0: Encode, L0: Encode, M0: Encode, N0: Encode, O0: Encode, P0: Encode, Q0: Encode, R0: Encode,

fn size_hint(&self) -> usize

fn encode_to<T>(&self, dest: &mut T)where T: Output + ?Sized,

impl<L0, M0, N0, O0, P0, Q0, R0> Encode for (L0, M0, N0, O0, P0, Q0, R0)where L0: Encode, M0: Encode, N0: Encode, O0: Encode, P0: Encode, Q0: Encode, R0: Encode,

fn size_hint(&self) -> usize

fn encode_to<T>(&self, dest: &mut T)where T: Output + ?Sized,

impl Encode for NonZeroU32

fn size_hint(&self) -> usize

fn encode_to<W>(&self, dest: &mut W)where W: Output + ?Sized,

fn encode(&self) -> Vec<u8, Global> ⓘ

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

impl<T> Encode for LinkedList<T, Global>where T: Encode,

fn size_hint(&self) -> usize

fn encode_to<W>(&self, dest: &mut W)where W: Output + ?Sized,