Trait parity_scale_codec::Encode

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

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

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.

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

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

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

Convert self to an owned vector.

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

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

fn encoded_size(&self) -> usize

Calculates the encoded size.

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

Note

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.

Loading content...

Implementations on Foreign Types

impl<T: Encode, E: Encode> Encode for Result<T, E>

fn size_hint(&self) -> usize

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

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

fn size_hint(&self) -> usize

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

impl Encode for NonZeroI8

fn size_hint(&self) -> usize

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

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

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

impl Encode for NonZeroI16

fn size_hint(&self) -> usize

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

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

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

impl Encode for NonZeroI32

fn size_hint(&self) -> usize

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

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

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

impl Encode for NonZeroI64

fn size_hint(&self) -> usize

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

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

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

impl Encode for NonZeroI128

fn size_hint(&self) -> usize

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

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

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

impl Encode for NonZeroU8

fn size_hint(&self) -> usize

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

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

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

impl Encode for NonZeroU16

fn size_hint(&self) -> usize

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

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

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

impl Encode for NonZeroU32

fn size_hint(&self) -> usize

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

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

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

impl Encode for NonZeroU64

fn size_hint(&self) -> usize

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

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

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

impl Encode for NonZeroU128

fn size_hint(&self) -> usize

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

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

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

impl<T: Encode, const N: usize> Encode for [T; N]

fn size_hint(&self) -> usize

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

impl Encode for str

fn size_hint(&self) -> usize

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

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

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

impl<T> Encode for PhantomData<T>

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

impl<T: Encode> Encode for [T]

fn size_hint(&self) -> usize

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

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

fn size_hint(&self) -> usize

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

impl<T: Encode> Encode for BTreeSet<T>

fn size_hint(&self) -> usize

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

impl<T: Encode> Encode for LinkedList<T>

fn size_hint(&self) -> usize

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

impl<T: Encode> Encode for BinaryHeap<T>

fn size_hint(&self) -> usize

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

impl<T: Encode> Encode for VecDeque<T>

fn size_hint(&self) -> usize

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

impl Encode for ()

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

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

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

impl<A0: Encode, B0: Encode, C0: Encode, D0: Encode, E0: Encode, 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> Encode for (A0, B0, C0, D0, E0, F0, G0, H0, I0, J0, K0, L0, M0, N0, O0, P0, Q0, R0)

fn size_hint(&self) -> usize

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

impl<B0: Encode, C0: Encode, D0: Encode, E0: Encode, 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> Encode for (B0, C0, D0, E0, F0, G0, H0, I0, J0, K0, L0, M0, N0, O0, P0, Q0, R0)

fn size_hint(&self) -> usize

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

impl<C0: Encode, D0: Encode, E0: Encode, 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> Encode for (C0, D0, E0, F0, G0, H0, I0, J0, K0, L0, M0, N0, O0, P0, Q0, R0)

fn size_hint(&self) -> usize

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

impl<D0: Encode, E0: Encode, 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> Encode for (D0, E0, F0, G0, H0, I0, J0, K0, L0, M0, N0, O0, P0, Q0, R0)

fn size_hint(&self) -> usize

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

impl<E0: Encode, 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> Encode for (E0, F0, G0, H0, I0, J0, K0, L0, M0, N0, O0, P0, Q0, R0)

fn size_hint(&self) -> usize

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

impl<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> Encode for (F0, G0, H0, I0, J0, K0, L0, M0, N0, O0, P0, Q0, R0)

fn size_hint(&self) -> usize

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

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

fn size_hint(&self) -> usize

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

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

fn size_hint(&self) -> usize

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

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

fn size_hint(&self) -> usize

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

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

fn size_hint(&self) -> usize

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

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

fn size_hint(&self) -> usize

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

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

fn size_hint(&self) -> usize

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

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

fn size_hint(&self) -> usize

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

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

fn size_hint(&self) -> usize

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

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

fn size_hint(&self) -> usize

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

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

fn size_hint(&self) -> usize

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

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

fn size_hint(&self) -> usize

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

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

fn size_hint(&self) -> usize

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

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

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

impl Encode for u16

const TYPE_INFO: TypeInfo

fn size_hint(&self) -> usize

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

impl Encode for u32

const TYPE_INFO: TypeInfo

fn size_hint(&self) -> usize

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

impl Encode for u64

const TYPE_INFO: TypeInfo

fn size_hint(&self) -> usize

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

impl Encode for u128

const TYPE_INFO: TypeInfo

fn size_hint(&self) -> usize

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

impl Encode for i16

const TYPE_INFO: TypeInfo

fn size_hint(&self) -> usize

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

impl Encode for i32

const TYPE_INFO: TypeInfo

fn size_hint(&self) -> usize

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

impl Encode for i64

const TYPE_INFO: TypeInfo

fn size_hint(&self) -> usize

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

impl Encode for i128

const TYPE_INFO: TypeInfo

fn size_hint(&self) -> usize

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

impl Encode for u8

const TYPE_INFO: TypeInfo

fn size_hint(&self) -> usize

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

impl Encode for i8

const TYPE_INFO: TypeInfo

fn size_hint(&self) -> usize

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

impl Encode for bool

fn size_hint(&self) -> usize

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

impl Encode for Duration

fn size_hint(&self) -> usize

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

Loading content...

Implementors

impl Encode for OptionBool

fn size_hint(&self) -> usize

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

impl<T> Encode for Compact<T> where
    CompactRef<'a, T>: Encode, 

fn size_hint(&self) -> usize

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

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

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

impl<T: ?Sized, X> Encode for X where
    T: Encode,
    X: WrapperTypeEncode<Target = T>, 

fn size_hint(&self) -> usize

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

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

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

Loading content...