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 ModuleKind

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

where R: ByteReader,

impl Deserializable for LibraryNamespace

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

where R: ByteReader,

impl Deserializable for Operation

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

where R: ByteReader,

impl Deserializable for NodeMutation

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

where R: ByteReader,

impl Deserializable for AccountIdPrefix

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

where R: ByteReader,

impl Deserializable for AccountUpdateDetails

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

where R: ByteReader,

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 LibraryPath

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

where R: ByteReader,

impl Deserializable for KernelLibrary

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

where R: ByteReader,

impl Deserializable for Library

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

where R: ByteReader,

impl Deserializable for Version

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

where R: ByteReader,

impl Deserializable for AdviceMap

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

where R: ByteReader,

impl Deserializable for SourceSpan

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

where R: ByteReader,

impl Deserializable for Kernel

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

where R: ByteReader,

impl Deserializable for MastForest

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

where R: ByteReader,

impl Deserializable for Program

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

where R: ByteReader,

impl Deserializable for ProgramInfo

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

where R: ByteReader,

impl Deserializable for StackInputs

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

where R: ByteReader,

impl Deserializable for StackOutputs

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

where R: ByteReader,

impl Deserializable for PubKeyPoly

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

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

where R: ByteReader,

impl Deserializable for NodeIndex

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

where R: ByteReader,

impl Deserializable for PartialMmr

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

where R: ByteReader,

impl Deserializable for PartialMerkleTree

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

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

where R: ByteReader,

impl Deserializable for InnerNode

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

where R: ByteReader,

impl Deserializable for StoreNode

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

where R: ByteReader,

impl Deserializable for RpxRandomCoin

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

where R: ByteReader,

impl Deserializable for AccountIdPrefixV0

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

where R: ByteReader,

impl Deserializable for AccountIdV0

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

where R: ByteReader,

impl Deserializable for AccountProcedureInfo

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

where R: ByteReader,

impl Deserializable for AccountStorageDelta

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

where R: ByteReader,

impl Deserializable for StorageMapDelta

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

where R: ByteReader,

impl Deserializable for AccountDelta

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

where R: ByteReader,

impl Deserializable for AccountStorageHeader

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

where R: ByteReader,

impl Deserializable for StorageMap

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

where R: ByteReader,

impl Deserializable for BlockNoteTree

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

where R: ByteReader,

impl Deserializable for Block

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

where R: ByteReader,

impl Deserializable for BlockAccountUpdate

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

where R: ByteReader,

impl Deserializable for NoteDetails

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

where R: ByteReader,

impl Deserializable for NoteHeader

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

where R: ByteReader,

impl Deserializable for NoteLocation

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

where R: ByteReader,

impl Deserializable for PartialNote

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

where R: ByteReader,

impl Deserializable for ChainMmr

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

where R: ByteReader,

impl Deserializable for TransactionMeasurements

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

where R: ByteReader,

impl Deserializable for TransactionInputs

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

where R: ByteReader,

impl Deserializable for TransactionOutputs

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

where R: ByteReader,

impl Deserializable for InputNoteCommitment

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

where R: ByteReader,

impl Deserializable for TxAccountUpdate

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

where R: ByteReader,

impl Deserializable for TransactionArgs

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

where R: ByteReader,

impl Deserializable for TransactionWitness

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

where R: ByteReader,

impl Deserializable for AdviceInputs

fn read_from<R>(source: &mut R) -> Result<AdviceInputs, 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<B> Deserializable for QuadExtension<B>

where B: ExtensibleField<2>,

fn read_from<R>( source: &mut R, ) -> Result<QuadExtension<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 Span<T>

where T: Deserializable,

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

where R: ByteReader,

impl<T> Deserializable for MerkleStore<T>

where T: KvMap<RpoDigest, StoreNode>,

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

where R: ByteReader,

impl<T> Deserializable for InputNotes<T>

where T: Deserializable + ToInputNoteCommitments,

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

impl Deserializable for MapRepresentation

impl Deserializable for StorageEntry

impl Deserializable for StorageSlotType

impl Deserializable for WordRepresentation

impl Deserializable for AccountId

impl Deserializable for AccountType

impl Deserializable for StorageSlot

impl Deserializable for Asset

impl Deserializable for AuthSecretKey

impl Deserializable for SmtLeaf

impl Deserializable for NoteFile

impl Deserializable for NoteType

impl Deserializable for InputNoteState

impl Deserializable for OutputNoteState

impl Deserializable for NoteTagSource

impl Deserializable for ForeignAccount

impl Deserializable for InputNote

impl Deserializable for OutputNote

impl Deserializable for AccountComponentMetadata

impl Deserializable for AccountComponentTemplate

impl Deserializable for StoragePlaceholder

impl Deserializable for Account

impl Deserializable for AccountCode

impl Deserializable for AccountData

impl Deserializable for AccountHeader

impl Deserializable for AccountStorage

impl Deserializable for AccountVaultDelta

impl Deserializable for AssetVault

impl Deserializable for FungibleAsset

impl Deserializable for FungibleAssetDelta

impl Deserializable for NonFungibleAsset

impl Deserializable for NonFungibleAssetDelta

impl Deserializable for BlockHeader

impl Deserializable for RpoDigest

impl Deserializable for InOrderIndex

impl Deserializable for MerklePath

impl Deserializable for RpoRandomCoin

impl Deserializable for SecretKey

impl Deserializable for SmtProof

impl Deserializable for BlockNumber

impl Deserializable for Note

impl Deserializable for NoteAssets

impl Deserializable for NoteId

impl Deserializable for NoteInclusionProof

impl Deserializable for NoteInputs

impl Deserializable for NoteMetadata

impl Deserializable for NoteRecipient

impl Deserializable for NoteScript

impl Deserializable for NoteTag

impl Deserializable for Nullifier

impl Deserializable for AccountStorageRequirements

impl Deserializable for CommittedNoteState

impl Deserializable for ConsumedAuthenticatedLocalNoteState

impl Deserializable for ExpectedNoteState

impl Deserializable for InvalidNoteState

impl Deserializable for ProcessingAuthenticatedNoteState

impl Deserializable for ProcessingUnauthenticatedNoteState

impl Deserializable for UnverifiedNoteState

impl Deserializable for InputNoteRecord

impl Deserializable for miden_client::Felt

impl Deserializable for SyncSummary

impl Deserializable for ExecutedTransaction

impl Deserializable for ForeignAccountInputs

impl Deserializable for OutputNotes

impl Deserializable for ProvenTransaction

impl Deserializable for TransactionId

impl Deserializable for TransactionRequest

impl Deserializable for TransactionResult

impl Deserializable for TransactionScript

impl<const DEPTH: u8> Deserializable for LeafIndex<DEPTH>