Trait CanonicalDeserialize

pub trait CanonicalDeserialize: Valid {
    // Required method
    fn deserialize_with_mode<R: Read>(
        reader: R,
        compress: Compress,
        validate: Validate,
    ) -> Result<Self, SerializationError>;

    // Provided methods
    fn deserialize_compressed<R: Read>(
        reader: R,
    ) -> Result<Self, SerializationError> { ... }
    fn deserialize_compressed_unchecked<R: Read>(
        reader: R,
    ) -> Result<Self, SerializationError> { ... }
    fn deserialize_uncompressed<R: Read>(
        reader: R,
    ) -> Result<Self, SerializationError> { ... }
    fn deserialize_uncompressed_unchecked<R: Read>(
        reader: R,
    ) -> Result<Self, SerializationError> { ... }
}

Deserializer in little endian format. This trait can be derived if all fields of a struct implement CanonicalDeserialize and the derive feature is enabled.

Example

// The `derive` feature must be set for the derivation to work.
use ark_serialize::*;

#[derive(CanonicalDeserialize)]
struct TestStruct {
    a: u64,
    b: (u64, (u64, u64)),
}

Required Methods

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

The general deserialize method that takes in customization flags.

Provided Methods

fn deserialize_compressed<R: Read>( reader: R, ) -> Result<Self, SerializationError>

fn deserialize_compressed_unchecked<R: Read>( reader: R, ) -> Result<Self, SerializationError>

fn deserialize_uncompressed<R: Read>( reader: R, ) -> Result<Self, SerializationError>

fn deserialize_uncompressed_unchecked<R: Read>( reader: R, ) -> Result<Self, SerializationError>

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 CanonicalDeserialize for bool

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl CanonicalDeserialize for u8

fn deserialize_with_mode<R: Read>( reader: R, _compress: Compress, _validate: Validate, ) -> Result<Self, SerializationError>

impl CanonicalDeserialize for u16

fn deserialize_with_mode<R: Read>( reader: R, _compress: Compress, _validate: Validate, ) -> Result<Self, SerializationError>

impl CanonicalDeserialize for u32

fn deserialize_with_mode<R: Read>( reader: R, _compress: Compress, _validate: Validate, ) -> Result<Self, SerializationError>

impl CanonicalDeserialize for u64

fn deserialize_with_mode<R: Read>( reader: R, _compress: Compress, _validate: Validate, ) -> Result<Self, SerializationError>

impl CanonicalDeserialize for ()

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl CanonicalDeserialize for usize

fn deserialize_with_mode<R: Read>( reader: R, _compress: Compress, _validate: Validate, ) -> Result<Self, SerializationError>

impl CanonicalDeserialize for String

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl CanonicalDeserialize for BigUint

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl<'a, T> CanonicalDeserialize for Cow<'a, T>

where T: ToOwned + Valid + Sync + Send, <T as ToOwned>::Owned: CanonicalDeserialize + Valid + Send,

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl<A> CanonicalDeserialize for (A,)

where A: CanonicalDeserialize,

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl<A, B> CanonicalDeserialize for (A, B)

where A: CanonicalDeserialize, B: CanonicalDeserialize,

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl<A, B, C> CanonicalDeserialize for (A, B, C)

where A: CanonicalDeserialize, B: CanonicalDeserialize, C: CanonicalDeserialize,

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl<A, B, C, D> CanonicalDeserialize for (A, B, C, D)

where A: CanonicalDeserialize, B: CanonicalDeserialize, C: CanonicalDeserialize, D: CanonicalDeserialize,

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl<A, B, C, D, E> CanonicalDeserialize for (A, B, C, D, E)

where A: CanonicalDeserialize, B: CanonicalDeserialize, C: CanonicalDeserialize, D: CanonicalDeserialize, E: CanonicalDeserialize,

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl<K, V> CanonicalDeserialize for BTreeMap<K, V>

where K: Ord + CanonicalDeserialize, V: CanonicalDeserialize,

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

Deserializes a BTreeMap from len(map) || key 1 || value 1 || ... || key n || value n.

impl<T: Send + Sync> CanonicalDeserialize for PhantomData<T>

fn deserialize_with_mode<R: Read>( _reader: R, _compress: Compress, _validate: Validate, ) -> Result<Self, SerializationError>

impl<T: CanonicalDeserialize + ToOwned + Sync + Send> CanonicalDeserialize for Arc<T>

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl<T: CanonicalDeserialize> CanonicalDeserialize for Option<T>

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl<T: CanonicalDeserialize> CanonicalDeserialize for LinkedList<T>

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl<T: CanonicalDeserialize> CanonicalDeserialize for VecDeque<T>

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl<T: CanonicalDeserialize> CanonicalDeserialize for Vec<T>

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl<T: CanonicalDeserialize, const N: usize> CanonicalDeserialize for [T; N]

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

impl<V> CanonicalDeserialize for BTreeSet<V>

where V: Ord + CanonicalDeserialize,

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

Deserializes a BTreeSet from len(map) || value 1 || ... || value n.

Implementors