Trait elrond_codec::TopDecode

source · [−]
pub trait TopDecode: Sized {
    fn top_decode<I: TopDecodeInput>(input: I) -> Result<Self, DecodeError>;

    fn top_decode_or_exit<I: TopDecodeInput, ExitCtx: Clone>(
        input: I, 
        c: ExitCtx, 
        exit: fn(_: ExitCtx, _: DecodeError) -> !
    ) -> Self { ... }
}
Expand description

Trait that allows zero-copy read of values from an underlying API in big endian format.

‘Top’ stands for the fact that values are deserialized on their own, so we have the benefit of knowing their length. This is useful in many scnearios, such as not having to encode Vec length and others.

The opther optimization that can be done when deserializing top-level objects is using special functions from the underlying API that do some of the work for the deserializer. These include getting values directly as i64/u64 or wrapping them directly into an owned Box<u8>.

BigInt/BigUint handling is not included here, because these are API-dependent and would overly complicate the trait.

Required methods

Attempt to deserialize the value from input.

Provided methods

Version of top_decode that exits quickly in case of error. Its purpose is to create smaller implementations in cases where the application is supposed to exit directly on decode error.

Implementations on Foreign Types

Quick exit for any of the contained types

Implementors