Trait Deserializable 

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

    // Provided method
    fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError> { ... }
}

Defines how to deserialize Self from bytes.

Required Methods

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

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.

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.

Implementations on Foreign Types

impl Deserializable for HashFunction

fn read_from<R>(source: &mut R) -> Result<HashFunction, 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 BatchingMethod

fn read_from<R>(source: &mut R) -> Result<BatchingMethod, DeserializationError>

where R: ByteReader,

Reads BatchingMethod from the specified source and returns the result.

Errors

Returns an error if the value does not correspond to a valid BatchingMethod.

impl Deserializable for FieldExtension

fn read_from<R>(source: &mut R) -> Result<FieldExtension, DeserializationError>

where R: ByteReader,

Reads a field extension enum from the specified source.

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,

impl Deserializable for String

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

where R: ByteReader,

impl Deserializable for ExecutionProof

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

where R: ByteReader,

impl Deserializable for PublicInputs

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

where R: ByteReader,

impl Deserializable for AdviceMap

fn read_from<R>(source: &mut R) -> Result<AdviceMap, DeserializationError>

where R: ByteReader,

impl Deserializable for PubKeyPoly

fn read_from<R>(source: &mut R) -> Result<PubKeyPoly, DeserializationError>

where R: ByteReader,

impl Deserializable for SecretKey

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

where R: ByteReader,

impl Deserializable for Signature

fn read_from<R>(source: &mut R) -> Result<Signature, DeserializationError>

where R: ByteReader,

impl Deserializable for SignatureHeader

fn read_from<R>(source: &mut R) -> Result<SignatureHeader, DeserializationError>

where R: ByteReader,

impl Deserializable for SignaturePoly

fn read_from<R>(source: &mut R) -> Result<SignaturePoly, DeserializationError>

where R: ByteReader,

impl Deserializable for Nonce

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

where R: ByteReader,

impl Deserializable for Forest

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

where R: ByteReader,

impl Deserializable for Mmr

fn read_from<R>(source: &mut R) -> Result<Mmr, 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 RootPath

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

where R: ByteReader,

impl Deserializable for ValuePath

fn read_from<R>(source: &mut R) -> Result<ValuePath, DeserializationError>

where R: ByteReader,

impl Deserializable for SmtProof

fn read_from<R>(source: &mut R) -> Result<SmtProof, DeserializationError>

where R: ByteReader,

impl Deserializable for Smt

fn read_from<R>(source: &mut R) -> Result<Smt, 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 StoreNode

fn read_from<R>(source: &mut R) -> Result<StoreNode, DeserializationError>

where R: ByteReader,

impl Deserializable for SourceSpan

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

where R: ByteReader,

impl Deserializable for TraceInfo

fn read_from<R>(source: &mut R) -> Result<TraceInfo, DeserializationError>

where R: ByteReader,

Reads TraceInfo from the specified source and returns the result.

Errors

Returns an error of a valid TraceInfo struct could not be read from the specified source.

impl Deserializable for ProofOptions

fn read_from<R>(source: &mut R) -> Result<ProofOptions, DeserializationError>

where R: ByteReader,

Reads proof options from the specified source and returns the result.

Errors

Returns an error of a valid proof options could not be read from the specified source.

impl Deserializable for Commitments

fn read_from<R>(source: &mut R) -> Result<Commitments, DeserializationError>

where R: ByteReader,

Reads commitments from the specified source and returns the result.

Errors

Returns an error of a valid Commitments struct could not be read from the specified source.

impl Deserializable for Context

fn read_from<R>(source: &mut R) -> Result<Context, DeserializationError>

where R: ByteReader,

Reads proof context from the specified source and returns the result.

Errors

Returns an error of a valid Context struct could not be read from the specified source.

impl Deserializable for OodFrame

fn read_from<R>(source: &mut R) -> Result<OodFrame, DeserializationError>

where R: ByteReader,

Reads a OOD frame from the specified source and returns the result

Errors

Returns an error of a valid OOD frame could not be read from the specified source.

impl Deserializable for Queries

fn read_from<R>(source: &mut R) -> Result<Queries, DeserializationError>

where R: ByteReader,

Reads a query struct from the specified source and returns the result

Errors

Returns an error of a valid query struct could not be read from the specified source.

impl Deserializable for Proof

fn read_from<R>(source: &mut R) -> Result<Proof, DeserializationError>

where R: ByteReader,

impl Deserializable for FriProof

fn read_from<R>(source: &mut R) -> Result<FriProof, DeserializationError>

where R: ByteReader,

Reads a FRI proof from the specified source and returns the result.

Errors

Returns an error if a valid proof could not be read from the source.

impl Deserializable for BaseElement

fn read_from<R>(source: &mut R) -> Result<BaseElement, DeserializationError>

where R: ByteReader,

impl Deserializable for BaseElement

fn read_from<R>(source: &mut R) -> Result<BaseElement, DeserializationError>

where R: ByteReader,

impl<B> Deserializable for CubeExtension<B>

where B: ExtensibleField<3>,

fn read_from<R>( source: &mut R, ) -> Result<CubeExtension<B>, DeserializationError>

where R: ByteReader,

impl<H> Deserializable for BatchMerkleProof<H>

where H: Hasher,

fn read_from<R>( source: &mut R, ) -> Result<BatchMerkleProof<H>, DeserializationError>

where R: ByteReader,

Parses internal nodes from the provided source, and constructs a batch Merkle proof from these nodes.

Errors

Returns an error if:

• source could not be deserialized into a valid set of internal nodes.

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> Deserializable for LeafIndex<DEPTH>

fn read_from<R>( source: &mut R, ) -> Result<LeafIndex<DEPTH>, 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,

impl<const N: usize> Deserializable for Blake3Digest<N>

fn read_from<R>(source: &mut R) -> Result<Blake3Digest<N>, DeserializationError>

where R: ByteReader,

Implementors

impl Deserializable for Operation

impl Deserializable for MerklePath

impl Deserializable for NodeIndex

impl Deserializable for PartialMerkleTree

impl Deserializable for RpoRandomCoin

impl Deserializable for RpxRandomCoin

impl Deserializable for AdviceInputs

impl Deserializable for miden_processor::Felt

impl Deserializable for Kernel

impl Deserializable for MastForest

impl Deserializable for Program

impl Deserializable for ProgramInfo

impl Deserializable for StackInputs

impl Deserializable for StackOutputs

impl Deserializable for Word

impl<B> Deserializable for QuadExtension<B>

where B: ExtensibleField<2>,

impl<T> Deserializable for MerkleStore<T>

where T: KvMap<Word, StoreNode>,