Trait CanonicalDeserialize 

pub trait CanonicalDeserialize: Valid + Sized {
    // 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>

Reads Self from reader using the compressed form if applicable. Performs validation if applicable.

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

Reads Self from reader using the compressed form if applicable, without validating the deserialized value.

Note

This should be used with caution, as it may lead to invalid values being used in subsequent computations, which may have security implications depending on the context.

It should only be used when the caller can guarantee that the input is valid, e.g. if it was generated by a trusted source.

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

Reads Self from reader using the uncompressed form. Performs validation if applicable.

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

Reads Self from reader using the uncompressed form, without validating the deserialized value.

Note

This should be used with caution, as it may lead to invalid values being used in subsequent computations, which may have security implications depending on the context.

It should only be used when the caller can guarantee that the input is valid, e.g. if it was generated by a trusted source.

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 i8

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

impl CanonicalDeserialize for i16

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

impl CanonicalDeserialize for i32

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

impl CanonicalDeserialize for i64

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

impl CanonicalDeserialize for isize

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 BigUint

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<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<K, V> CanonicalDeserialize for HashMap<K, V>

where K: Hash + Eq + CanonicalDeserialize, V: CanonicalDeserialize,

Available on crate feature std only.

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

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

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

where T: ?Sized + 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<T> CanonicalDeserialize for Box<[T]>

where T: CanonicalDeserialize,

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

impl<T> CanonicalDeserialize for BTreeSet<T>

where T: CanonicalDeserialize + Ord,

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

impl<T> CanonicalDeserialize for LinkedList<T>

where T: CanonicalDeserialize,

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

impl<T> CanonicalDeserialize for VecDeque<T>

where T: CanonicalDeserialize,

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

impl<T> CanonicalDeserialize for Vec<T>

where T: CanonicalDeserialize,

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

impl<T> CanonicalDeserialize for HashSet<T>

where T: CanonicalDeserialize + Hash + Eq,

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

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>

Available on target_has_atomic=ptr only.

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, const N: usize> CanonicalDeserialize for [T; N]

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

Implementors

impl<T: CanonicalDeserialize> CanonicalDeserialize for CompressedChecked<T>

impl<T: CanonicalDeserialize> CanonicalDeserialize for CompressedUnchecked<T>

impl<T: CanonicalDeserialize> CanonicalDeserialize for UncompressedChecked<T>

impl<T: CanonicalDeserialize> CanonicalDeserialize for UncompressedUnchecked<T>