Trait Valid 

pub trait Valid: Sync {
    const TRIVIAL_CHECK: bool = false;

    // Required method
    fn check(&self) -> Result<(), SerializationError>;

    // Provided method
    fn batch_check<'a>(
        batch: impl Iterator<Item = &'a Self> + Send,
    ) -> Result<(), SerializationError>
       where Self: 'a { ... }
}

Provided Associated Constants

const TRIVIAL_CHECK: bool = false

Whether the check method is trivial (i.e. always returns Ok(())). If this is true, the batch_check method will skip all checks and return Ok(()). This should be set to true for types where check is trivial, e.g. integers, field elements, etc. This is false by default. This is primarily an optimization to skip unnecessary checks in batch_check.

Required Methods

fn check(&self) -> Result<(), SerializationError>

Checks whether self is valid. If self is valid, returns Ok(()). Otherwise, returns an error describing the failure. This method is called by deserialize_with_mode if validate is Validate::Yes.

Provided Methods

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

Checks whether all items in batch are valid. If all items are valid, returns Ok(()). Otherwise, returns an error describing the first failure.

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

const TRIVIAL_CHECK: Self = true

fn check(&self) -> Result<(), SerializationError>

impl Valid for i8

const TRIVIAL_CHECK: bool = true

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( _batch: impl Iterator<Item = &'a Self>, ) -> Result<(), SerializationError>

where Self: 'a,

impl Valid for i16

const TRIVIAL_CHECK: bool = true

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( _batch: impl Iterator<Item = &'a Self>, ) -> Result<(), SerializationError>

where Self: 'a,

impl Valid for i32

const TRIVIAL_CHECK: bool = true

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( _batch: impl Iterator<Item = &'a Self>, ) -> Result<(), SerializationError>

where Self: 'a,

impl Valid for i64

const TRIVIAL_CHECK: bool = true

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( _batch: impl Iterator<Item = &'a Self>, ) -> Result<(), SerializationError>

where Self: 'a,

impl Valid for isize

const TRIVIAL_CHECK: bool = true

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( _batch: impl Iterator<Item = &'a Self>, ) -> Result<(), SerializationError>

where Self: 'a,

impl Valid for u8

const TRIVIAL_CHECK: bool = true

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( _batch: impl Iterator<Item = &'a Self>, ) -> Result<(), SerializationError>

where Self: 'a,

impl Valid for u16

const TRIVIAL_CHECK: bool = true

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( _batch: impl Iterator<Item = &'a Self>, ) -> Result<(), SerializationError>

where Self: 'a,

impl Valid for u32

const TRIVIAL_CHECK: bool = true

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( _batch: impl Iterator<Item = &'a Self>, ) -> Result<(), SerializationError>

where Self: 'a,

impl Valid for u64

const TRIVIAL_CHECK: bool = true

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( _batch: impl Iterator<Item = &'a Self>, ) -> Result<(), SerializationError>

where Self: 'a,

impl Valid for ()

const TRIVIAL_CHECK: bool = true

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( _: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

impl Valid for usize

const TRIVIAL_CHECK: bool = true

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( _batch: impl Iterator<Item = &'a Self>, ) -> Result<(), SerializationError>

where Self: 'a,

impl Valid for String

fn check(&self) -> Result<(), SerializationError>

impl Valid for BigUint

const TRIVIAL_CHECK: bool = true

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( _batch: impl Iterator<Item = &'a Self>, ) -> Result<(), SerializationError>

where Self: 'a,

impl<A> Valid for (A,)

where A: Valid,

const TRIVIAL_CHECK: bool = <A as Valid>::TRIVIAL_CHECK

fn check(&self) -> Result<(), SerializationError>

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

where A: Valid, B: Valid,

const TRIVIAL_CHECK: bool

fn check(&self) -> Result<(), SerializationError>

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

where A: Valid, B: Valid, C: Valid,

const TRIVIAL_CHECK: bool

fn check(&self) -> Result<(), SerializationError>

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

where A: Valid, B: Valid, C: Valid, D: Valid,

const TRIVIAL_CHECK: bool

fn check(&self) -> Result<(), SerializationError>

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

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

const TRIVIAL_CHECK: bool

fn check(&self) -> Result<(), SerializationError>

impl<K: Valid, V: Valid> Valid for BTreeMap<K, V>

const TRIVIAL_CHECK: bool

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self>, ) -> Result<(), SerializationError>

where Self: 'a,

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

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

const TRIVIAL_CHECK: bool = <<T as ToOwned>::Owned>::TRIVIAL_CHECK

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

impl<T: Sync> Valid for PhantomData<T>

const TRIVIAL_CHECK: bool = true

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( _: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

impl<T: Valid> Valid for Option<T>

const TRIVIAL_CHECK: bool = T::TRIVIAL_CHECK

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

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

const TRIVIAL_CHECK: bool = T::TRIVIAL_CHECK

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

impl<T: Valid> Valid for BTreeSet<T>

const TRIVIAL_CHECK: bool = T::TRIVIAL_CHECK

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

impl<T: Valid> Valid for LinkedList<T>

const TRIVIAL_CHECK: bool = T::TRIVIAL_CHECK

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

impl<T: Valid> Valid for VecDeque<T>

const TRIVIAL_CHECK: bool = T::TRIVIAL_CHECK

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

impl<T: Valid> Valid for Vec<T>

const TRIVIAL_CHECK: bool = T::TRIVIAL_CHECK

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

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

const TRIVIAL_CHECK: bool = T::TRIVIAL_CHECK

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

impl<T: ?Sized + Valid + Sync + Send> Valid for Arc<T>

Available on target_has_atomic=ptr only.

const TRIVIAL_CHECK: bool = T::TRIVIAL_CHECK

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

Implementors

impl<T: Valid> Valid for CompressedChecked<T>

impl<T: Valid> Valid for CompressedUnchecked<T>

impl<T: Valid> Valid for UncompressedChecked<T>

impl<T: Valid> Valid for UncompressedUnchecked<T>