1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
use crate::{
codec_err::EncodeError, DefaultErrorHandler, EncodeErrorHandler, NestedEncodeOutput, TypeInfo,
};
use alloc::vec::Vec;
/// Most types will be encoded without any possibility of error.
/// The trait is used to provide these implementations.
/// This is currently not a substitute for implementing a proper NestedEncode.
pub trait NestedEncodeNoErr: Sized {
fn dep_encode_no_err<O: NestedEncodeOutput>(&self, dest: &mut O);
}
/// Trait that allows zero-copy write of value-references to slices in LE format.
///
/// Implementations should override `using_top_encoded` for value types and `dep_encode` and `size_hint` for allocating types.
/// Wrapper types should override all methods.
pub trait NestedEncode: Sized {
// !INTERNAL USE ONLY!
// This const helps SCALE to optimize the encoding/decoding by doing fake specialization.
#[doc(hidden)]
const TYPE_INFO: TypeInfo = TypeInfo::Unknown;
/// NestedEncode to output, using the format of an object nested inside another structure.
/// Does not provide compact version.
fn dep_encode<O: NestedEncodeOutput>(&self, dest: &mut O) -> Result<(), EncodeError> {
self.dep_encode_or_handle_err(dest, DefaultErrorHandler)
}
/// Version of `dep_encode` that can handle errors as soon as they occur.
/// For instance in 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.
fn dep_encode_or_handle_err<O, H>(&self, dest: &mut O, h: H) -> Result<(), H::HandledErr>
where
O: NestedEncodeOutput,
H: EncodeErrorHandler,
{
match self.dep_encode(dest) {
Ok(()) => Ok(()),
Err(e) => Err(h.handle_error(e)),
}
}
}
/// Convenience function for getting an object nested-encoded to a Vec<u8> directly.
pub fn dep_encode_to_vec<T: NestedEncode>(obj: &T) -> Result<Vec<u8>, EncodeError> {
let mut bytes = Vec::<u8>::new();
obj.dep_encode(&mut bytes)?;
Ok(bytes)
}