Struct Valid 

pub struct Valid<T>(/* private fields */);

A value that has been successfully validated.

Valid<T> is a zero-cost wrapper that carries proof of validation in the type system. Construction requires the value to pass Validate::validate. Once inside Valid<T>, the value is considered correct by the validation rules of T.

Examples

use reliakit_validate::{Validate, Valid, ValidationError};

struct Age(u8);

impl Validate for Age {
    type Error = ValidationError;
    fn validate(&self) -> Result<(), Self::Error> {
        if self.0 > 120 {
            return Err(ValidationError::new("age must not exceed 120"));
        }
        Ok(())
    }
}

let age = Valid::new(Age(25)).unwrap();
assert_eq!(age.0, 25);

Implementations

impl<T: Validate> Valid<T>

pub fn new(value: T) -> Result<Self, T::Error>

Validates and wraps the value. Returns an error if validation fails.

pub fn get(&self) -> &T

Returns a reference to the inner value.

pub fn into_inner(self) -> T

Consumes the wrapper and returns the inner value.

Trait Implementations

impl<T: Clone> Clone for Valid<T>

fn clone(&self) -> Valid<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Valid<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Validate> Deref for Valid<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Validate + Display> Display for Valid<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Hash> Hash for Valid<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Valid<T>

fn cmp(&self, other: &Valid<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Valid<T>

fn eq(&self, other: &Valid<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for Valid<T>

fn partial_cmp(&self, other: &Valid<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq> Eq for Valid<T>

impl<T> StructuralPartialEq for Valid<T>