pub trait TopDecode: Sized {
// Provided methods
fn top_decode<I>(input: I) -> Result<Self, DecodeError>
where I: TopDecodeInput { ... }
fn top_decode_or_handle_err<I, H>(
input: I,
h: H,
) -> Result<Self, H::HandledErr>
where I: TopDecodeInput,
H: DecodeErrorHandler { ... }
}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.
Provided Methods§
Sourcefn top_decode<I>(input: I) -> Result<Self, DecodeError>where
I: TopDecodeInput,
fn top_decode<I>(input: I) -> Result<Self, DecodeError>where
I: TopDecodeInput,
Attempt to deserialize the value from input.
Sourcefn top_decode_or_handle_err<I, H>(input: I, h: H) -> Result<Self, H::HandledErr>where
I: TopDecodeInput,
H: DecodeErrorHandler,
fn top_decode_or_handle_err<I, H>(input: I, h: H) -> Result<Self, H::HandledErr>where
I: TopDecodeInput,
H: DecodeErrorHandler,
Version of top_decode that can handle errors as soon as they occur.
For instance it can exit immediately and make sure that if it returns, it is a success.
By not deferring error handling, this can lead to somewhat smaller bytecode.
Dyn Compatibility§
This trait is not dyn compatible.
In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.