Trait CanonicalSerialize 

pub trait CanonicalSerialize {
    // Required methods
    fn serialize_with_mode<W: Write>(
        &self,
        writer: W,
        compress: Compress,
    ) -> Result<(), SerializationError>;
    fn serialized_size(&self, compress: Compress) -> usize;

    // Provided methods
    fn serialize_compressed<W: Write>(
        &self,
        writer: W,
    ) -> Result<(), SerializationError> { ... }
    fn compressed_size(&self) -> usize { ... }
    fn serialize_uncompressed<W: Write>(
        &self,
        writer: W,
    ) -> Result<(), SerializationError> { ... }
    fn uncompressed_size(&self) -> usize { ... }
}

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

Example

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

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

Required Methods

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

The general serialize method that takes in customization flags.

fn serialized_size(&self, compress: Compress) -> usize

Returns the size in bytes of the serialized version of self with the given compression mode.

Provided Methods

fn serialize_compressed<W: Write>( &self, writer: W, ) -> Result<(), SerializationError>

Serializes self into writer using the compressed form if applicable.

fn compressed_size(&self) -> usize

Returns the size in bytes of the compressed serialized version of self.

fn serialize_uncompressed<W: Write>( &self, writer: W, ) -> Result<(), SerializationError>

Serializes self into writer using the uncompressed form.

fn uncompressed_size(&self) -> usize

Returns the size in bytes of the uncompressed serialized version of 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.

Implementations on Foreign Types

impl CanonicalSerialize for bool

fn serialize_with_mode<W: Write>( &self, writer: W, _compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, _compress: Compress) -> usize

impl CanonicalSerialize for i8

fn serialize_with_mode<W: Write>( &self, writer: W, _compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, _compress: Compress) -> usize

impl CanonicalSerialize for i16

fn serialize_with_mode<W: Write>( &self, writer: W, _compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, _compress: Compress) -> usize

impl CanonicalSerialize for i32

fn serialize_with_mode<W: Write>( &self, writer: W, _compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, _compress: Compress) -> usize

impl CanonicalSerialize for i64

fn serialize_with_mode<W: Write>( &self, writer: W, _compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, _compress: Compress) -> usize

impl CanonicalSerialize for isize

fn serialize_with_mode<W: Write>( &self, writer: W, _compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, _compress: Compress) -> usize

impl CanonicalSerialize for u8

fn serialize_with_mode<W: Write>( &self, writer: W, _compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, _compress: Compress) -> usize

impl CanonicalSerialize for u16

fn serialize_with_mode<W: Write>( &self, writer: W, _compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, _compress: Compress) -> usize

impl CanonicalSerialize for u32

fn serialize_with_mode<W: Write>( &self, writer: W, _compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, _compress: Compress) -> usize

impl CanonicalSerialize for u64

fn serialize_with_mode<W: Write>( &self, writer: W, _compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, _compress: Compress) -> usize

impl CanonicalSerialize for ()

fn serialize_with_mode<W: Write>( &self, _writer: W, _compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, _compress: Compress) -> usize

impl CanonicalSerialize for usize

fn serialize_with_mode<W: Write>( &self, writer: W, _compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, _compress: Compress) -> usize

impl CanonicalSerialize for String

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

impl CanonicalSerialize for BigUint

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

impl<A> CanonicalSerialize for (A,)

where A: CanonicalSerialize,

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

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

where A: CanonicalSerialize, B: CanonicalSerialize,

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

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

where A: CanonicalSerialize, B: CanonicalSerialize, C: CanonicalSerialize,

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

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

where A: CanonicalSerialize, B: CanonicalSerialize, C: CanonicalSerialize, D: CanonicalSerialize,

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

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

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

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

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

where K: CanonicalSerialize, V: CanonicalSerialize,

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

Serializes a BTreeMap as len(map) || key 1 || value 1 || ... || key n || value n.

fn serialized_size(&self, compress: Compress) -> usize

impl<T> CanonicalSerialize for PhantomData<T>

fn serialize_with_mode<W: Write>( &self, _writer: W, _compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, _compress: Compress) -> usize

impl<T: CanonicalSerialize> CanonicalSerialize for &[T]

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

impl<T: CanonicalSerialize> CanonicalSerialize for &mut [T]

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

impl<T: CanonicalSerialize> CanonicalSerialize for Option<T>

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

impl<T: CanonicalSerialize> CanonicalSerialize for &T

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

impl<T: CanonicalSerialize> CanonicalSerialize for &mut T

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

impl<T: CanonicalSerialize> CanonicalSerialize for [T]

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

impl<T: CanonicalSerialize> CanonicalSerialize for Box<[T]>

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

impl<T: CanonicalSerialize> CanonicalSerialize for BTreeSet<T>

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

impl<T: CanonicalSerialize> CanonicalSerialize for LinkedList<T>

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

impl<T: CanonicalSerialize> CanonicalSerialize for VecDeque<T>

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

impl<T: CanonicalSerialize> CanonicalSerialize for Vec<T>

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

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

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

impl<T: ?Sized + CanonicalSerialize + ToOwned> CanonicalSerialize for Cow<'_, T>

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

impl<T: ?Sized + CanonicalSerialize + ToOwned> CanonicalSerialize for Rc<T>

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

impl<T: ?Sized + CanonicalSerialize + ToOwned> CanonicalSerialize for Arc<T>

Available on target_has_atomic=ptr only.

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

fn serialized_size(&self, compress: Compress) -> usize

Implementors

impl<T: CanonicalSerialize> CanonicalSerialize for CompressedChecked<T>

impl<T: CanonicalSerialize> CanonicalSerialize for CompressedUnchecked<T>

impl<T: CanonicalSerialize> CanonicalSerialize for UncompressedChecked<T>

impl<T: CanonicalSerialize> CanonicalSerialize for UncompressedUnchecked<T>