Trait Deserializable

Source

pub trait Deserializable: Sized {
    // Required method
    fn read_from<R>(source: &mut R) -> Result<Self, DeserializationError>
       where R: ByteReader;

    // Provided methods
    fn min_serialized_size() -> usize { ... }
    fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError> { ... }
    fn read_from_bytes_with_budget(
        bytes: &[u8],
        budget: usize,
    ) -> Result<Self, DeserializationError> { ... }
}

Expand description

Defines how to deserialize Self from bytes.

Required Methods§

Source

fn read_from<R>(source: &mut R) -> Result<Self, DeserializationError>
where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

§Errors

Returns an error if:

The source does not contain enough bytes to deserialize Self.
Bytes read from the source do not represent a valid value for Self.

Provided Methods§

Source

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

This is used by ByteReader::max_alloc to estimate how many elements can be deserialized from the remaining budget, preventing denial-of-service attacks from malicious length prefixes.

The default implementation returns size_of::<Self>(), which is conservative: it may reject valid input for types where the serialized size is smaller than the in-memory size (e.g., structs with computed/cached fields that aren’t serialized).

Override this method for types where the serialized representation is smaller than the in-memory representation to allow more elements to be deserialized.

Source

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

§Errors

Returns an error if:

The bytes do not contain enough information to deserialize Self.
The bytes do not represent a valid value for Self.

Note: if bytes contains more data than needed to deserialize self, no error is returned.

Source

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

This is the recommended method for deserializing untrusted input. The budget limits how many bytes can be consumed during deserialization, preventing denial-of-service attacks that exploit length fields to cause huge allocations.

§Errors

Returns an error if:

The budget is exhausted before deserialization completes.
The bytes do not contain enough information to deserialize Self.
The bytes do not represent a valid value for Self.

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.

Trait Deserializable Copy item path

Required Methods§

fn read_from<R>(source: &mut R) -> Result<Self, DeserializationError>where R: ByteReader,

§Errors

Provided Methods§

fn min_serialized_size() -> usize

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

§Errors

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

§Errors

Dyn Compatibility§

Implementations on Foreign Types§

impl Deserializable for HashFunction

fn read_from<R>(source: &mut R) -> Result<HashFunction, DeserializationError>where R: ByteReader,

impl Deserializable for SealingKey

fn read_from<R>(source: &mut R) -> Result<SealingKey, DeserializationError>where R: ByteReader,

impl Deserializable for UnsealingKey

fn read_from<R>(source: &mut R) -> Result<UnsealingKey, DeserializationError>where R: ByteReader,

impl Deserializable for NodeMutation

fn read_from<R>(source: &mut R) -> Result<NodeMutation, DeserializationError>where R: ByteReader,

impl Deserializable for SmtLeaf

fn read_from<R>(source: &mut R) -> Result<SmtLeaf, DeserializationError>where R: ByteReader,

impl Deserializable for u8

fn read_from<R>(source: &mut R) -> Result<u8, DeserializationError>where R: ByteReader,

impl Deserializable for u16

fn read_from<R>(source: &mut R) -> Result<u16, DeserializationError>where R: ByteReader,

impl Deserializable for u32

fn read_from<R>(source: &mut R) -> Result<u32, DeserializationError>where R: ByteReader,

impl Deserializable for u64

fn read_from<R>(source: &mut R) -> Result<u64, DeserializationError>where R: ByteReader,

impl Deserializable for u128

fn read_from<R>(source: &mut R) -> Result<u128, DeserializationError>where R: ByteReader,

impl Deserializable for ()

fn read_from<R>(_source: &mut R) -> Result<(), DeserializationError>where R: ByteReader,

impl Deserializable for usize

fn read_from<R>(source: &mut R) -> Result<usize, DeserializationError>where R: ByteReader,

fn min_serialized_size() -> usize

impl Deserializable for String

fn read_from<R>(source: &mut R) -> Result<String, DeserializationError>where R: ByteReader,

fn min_serialized_size() -> usize

impl Deserializable for PublicInputs

fn read_from<R>(source: &mut R) -> Result<PublicInputs, DeserializationError>where R: ByteReader,

impl Deserializable for ExecutionProof

fn read_from<R>(source: &mut R) -> Result<ExecutionProof, DeserializationError>where R: ByteReader,

impl Deserializable for EncryptedData

fn read_from<R>(source: &mut R) -> Result<EncryptedData, DeserializationError>where R: ByteReader,

impl Deserializable for Nonce

fn read_from<R>(source: &mut R) -> Result<Nonce, DeserializationError>where R: ByteReader,

impl Deserializable for SecretKey

fn read_from<R>(source: &mut R) -> Result<SecretKey, DeserializationError>where R: ByteReader,

impl Deserializable for EncryptedData

fn read_from<R>(source: &mut R) -> Result<EncryptedData, DeserializationError>where R: ByteReader,

impl Deserializable for Nonce

fn read_from<R>(source: &mut R) -> Result<Nonce, DeserializationError>where R: ByteReader,

impl Deserializable for SecretKey

fn read_from<R>(source: &mut R) -> Result<SecretKey, DeserializationError>where R: ByteReader,

impl Deserializable for EphemeralPublicKey

fn read_from<R>( source: &mut R, ) -> Result<EphemeralPublicKey, DeserializationError>where R: ByteReader,

impl Deserializable for EphemeralPublicKey

fn read_from<R>( source: &mut R, ) -> Result<EphemeralPublicKey, DeserializationError>where R: ByteReader,

impl Deserializable for SealedMessage

fn read_from<R>(source: &mut R) -> Result<SealedMessage, DeserializationError>where R: ByteReader,

impl Deserializable for Forest

fn read_from<R>(source: &mut R) -> Result<Forest, DeserializationError>where R: ByteReader,

impl Deserializable for InOrderIndex

fn read_from<R>(source: &mut R) -> Result<InOrderIndex, DeserializationError>where R: ByteReader,

impl Deserializable for PartialMmr

fn read_from<R>(source: &mut R) -> Result<PartialMmr, DeserializationError>where R: ByteReader,

impl Deserializable for MerkleProof

fn read_from<R>(source: &mut R) -> Result<MerkleProof, DeserializationError>where R: ByteReader,

impl Deserializable for RootPath

fn read_from<R>(source: &mut R) -> Result<RootPath, DeserializationError>where R: ByteReader,

impl Deserializable for PartialSmt

fn read_from<R>(source: &mut R) -> Result<PartialSmt, DeserializationError>where R: ByteReader,

impl Deserializable for SparseMerklePath

fn read_from<R>( source: &mut R, ) -> Result<SparseMerklePath, DeserializationError>where R: ByteReader,

impl Deserializable for SourceSpan

fn read_from<R>(source: &mut R) -> Result<SourceSpan, DeserializationError>where R: ByteReader,

impl<K, V> Deserializable for BTreeMap<K, V>where K: Deserializable + Ord, V: Deserializable,

fn read_from<R>(source: &mut R) -> Result<BTreeMap<K, V>, DeserializationError>where R: ByteReader,

Trait Deserializable

fn read_from<R>(source: &mut R) -> Result<Self, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<HashFunction, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<SealingKey, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<UnsealingKey, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<NodeMutation, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<SmtLeaf, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<u8, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<u16, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<u32, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<u64, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<u128, DeserializationError>
where R: ByteReader,

fn read_from<R>(_source: &mut R) -> Result<(), DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<usize, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<String, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<PublicInputs, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<ExecutionProof, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<EncryptedData, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<Nonce, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<SecretKey, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<EncryptedData, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<Nonce, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<SecretKey, DeserializationError>
where R: ByteReader,

fn read_from<R>( source: &mut R, ) -> Result<EphemeralPublicKey, DeserializationError>
where R: ByteReader,

fn read_from<R>( source: &mut R, ) -> Result<EphemeralPublicKey, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<SealedMessage, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<Forest, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<InOrderIndex, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<PartialMmr, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<MerkleProof, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<RootPath, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<PartialSmt, DeserializationError>
where R: ByteReader,

fn read_from<R>( source: &mut R, ) -> Result<SparseMerklePath, DeserializationError>
where R: ByteReader,

fn read_from<R>(source: &mut R) -> Result<SourceSpan, DeserializationError>
where R: ByteReader,

impl<K, V> Deserializable for BTreeMap<K, V>
where K: Deserializable + Ord, V: Deserializable,

fn read_from<R>(source: &mut R) -> Result<BTreeMap<K, V>, DeserializationError>
where R: ByteReader,

impl<T1> Deserializable for (T1,)
where T1: Deserializable,

fn read_from<R>(source: &mut R) -> Result<(T1,), DeserializationError>
where R: ByteReader,

impl<T1, T2> Deserializable for (T1, T2)
where T1: Deserializable, T2: Deserializable,

fn read_from<R>(source: &mut R) -> Result<(T1, T2), DeserializationError>
where R: ByteReader,

impl<T1, T2, T3> Deserializable for (T1, T2, T3)
where T1: Deserializable, T2: Deserializable, T3: Deserializable,

fn read_from<R>(source: &mut R) -> Result<(T1, T2, T3), DeserializationError>
where R: ByteReader,

impl<T1, T2, T3, T4> Deserializable for (T1, T2, T3, T4)
where T1: Deserializable, T2: Deserializable, T3: Deserializable, T4: Deserializable,

fn read_from<R>( source: &mut R, ) -> Result<(T1, T2, T3, T4), DeserializationError>
where R: ByteReader,

impl<T1, T2, T3, T4, T5> Deserializable for (T1, T2, T3, T4, T5)
where T1: Deserializable, T2: Deserializable, T3: Deserializable, T4: Deserializable, T5: Deserializable,

fn read_from<R>( source: &mut R, ) -> Result<(T1, T2, T3, T4, T5), DeserializationError>
where R: ByteReader,

impl<T1, T2, T3, T4, T5, T6> Deserializable for (T1, T2, T3, T4, T5, T6)
where T1: Deserializable, T2: Deserializable, T3: Deserializable, T4: Deserializable, T5: Deserializable, T6: Deserializable,

fn read_from<R>( source: &mut R, ) -> Result<(T1, T2, T3, T4, T5, T6), DeserializationError>
where R: ByteReader,

impl<T> Deserializable for Option<T>
where T: Deserializable,

fn read_from<R>(source: &mut R) -> Result<Option<T>, DeserializationError>
where R: ByteReader,

impl<T> Deserializable for BTreeSet<T>
where T: Deserializable + Ord,

fn read_from<R>(source: &mut R) -> Result<BTreeSet<T>, DeserializationError>
where R: ByteReader,

impl<T> Deserializable for Vec<T>
where T: Deserializable,

fn read_from<R>(source: &mut R) -> Result<Vec<T>, DeserializationError>
where R: ByteReader,

impl<T> Deserializable for LexicographicWord<T>
where T: Into<Word> + From<Word>,

fn read_from<R>( source: &mut R, ) -> Result<LexicographicWord<T>, DeserializationError>
where R: ByteReader,

impl<T> Deserializable for Span<T>
where T: Deserializable,

fn read_from<R>(source: &mut R) -> Result<Span<T>, DeserializationError>
where R: ByteReader,

impl<T, const C: usize> Deserializable for [T; C]
where T: Deserializable,

fn read_from<R>(source: &mut R) -> Result<[T; C], DeserializationError>
where R: ByteReader,

impl<const DEPTH: u8, K, V> Deserializable for MutationSet<DEPTH, K, V>
where K: Deserializable + Ord + Eq + Hash, V: Deserializable,

fn read_from<R>( source: &mut R, ) -> Result<MutationSet<DEPTH, K, V>, DeserializationError>
where R: ByteReader,