Enum frunk::validated::Validated

pub enum Validated<T, E> where
    T: HList,  {
    Ok(T),
    Err(Vec<E>),
}

A Validated is either an Ok holding an HList or an Err, holding a vector of collected errors.

Variants

Ok(T)Err(Vec<E>)

Methods

impl<T, E> Validated<T, E> where
    T: HList, 

pub fn is_ok(&self) -> bool

Returns true if this validation is Ok, false otherwise

Examples

use frunk::Validated;
use frunk::prelude::*;

let r1: Result<String, String> = Result::Ok(String::from("hello"));
let v = r1.into_validated();
assert!(v.is_ok());

pub fn is_err(&self) -> bool

Returns true if this validation is Err, false otherwise

Examples

use frunk::prelude::*;

let r1: Result<String, i32> = Result::Err(32);
let v = r1.into_validated();
assert!(v.is_err());

pub fn into_result(self) -> Result<T, Vec<E>>

Turns this Validated into a Result.

If this Validated is Ok, it will become a Result::Ok, holding an HList of all the accumulated results. Otherwise, it will become a Result::Err with a list of all accumulated errors.

Examples

#[macro_use] extern crate frunk;

use frunk::Validated;
use frunk::prelude::*;

#[derive(PartialEq, Eq, Debug)]
struct Person {
    age: i32,
    name: String,
}

fn get_name() -> Result<String, String> {
    Result::Ok("James".to_owned())
}

fn get_age() -> Result<i32, String> {
    Result::Ok(32)
}

let v = get_name().into_validated() + get_age();
let person = v.into_result()
               .map(|hlist_pat!(name, age)| {
                    Person {
                        name: name,
                        age: age,
                    }
                });

 assert_eq!(person.unwrap(),
            Person {
                name: "James".to_owned(),
                age: 32,
            });

Trait Implementations

impl<T: Clone, E: Clone> Clone for Validated<T, E> where
    T: HList, 

fn clone(&self) -> Validated<T, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PartialEq, E: PartialEq> PartialEq<Validated<T, E>> for Validated<T, E> where
    T: HList, 

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Validated<T, E>) -> bool

This method tests for !=.

impl<T: PartialOrd, E: PartialOrd> PartialOrd<Validated<T, E>> for Validated<T, E> where
    T: HList, 

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

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

fn lt(&self, other: &Validated<T, E>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Validated<T, E>) -> bool

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

fn gt(&self, other: &Validated<T, E>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Validated<T, E>) -> bool

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

impl<T: Ord, E: Ord> Ord for Validated<T, E> where
    T: HList, 

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.

impl<T: Eq, E: Eq> Eq for Validated<T, E> where
    T: HList, 

impl<T: Hash, E: Hash> Hash for Validated<T, E> where
    T: HList, 

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<T, E, T2> Add<Result<T2, E>> for Validated<T, E> where
    T: HList + Add<HCons<T2, HNil>>,
    <T as Add<HCons<T2, HNil>>>::Output: HList, 

Implements Add for the current Validated with a Result, returning a new Validated.

Examples

use frunk::Validated;
use frunk::prelude::*;

let r1: Result<String, String> = Result::Ok(String::from("hello"));
let r2: Result<i32, String> = Result::Ok(1);
let v = r1.into_validated() + r2;
assert_eq!(v, Validated::Ok(hlist!(String::from("hello"), 1)))

type Output = Validated<<T as Add<HCons<T2, HNil>>>::Output, E>

The resulting type after applying the + operator.

fn add(self, other: Result<T2, E>) -> Self::Output

Performs the + operation.

impl<T, E, T2> Add<Validated<T2, E>> for Validated<T, E> where
    T: HList + Add<T2>,
    T2: HList,
    <T as Add<T2>>::Output: HList, 

Implements Add for the current Validated with another Validated, returning a new Validated.

Examples

use frunk::Validated;
use frunk::prelude::*;

let r1: Result<String, String> = Result::Ok(String::from("hello"));
let r2: Result<i32, String> = Result::Ok(1);
let v1 = r1.into_validated();
let v2 = r2.into_validated();
let v3 = v1 + v2;
assert_eq!(v3, Validated::Ok(hlist!(String::from("hello"), 1)))

type Output = Validated<<T as Add<T2>>::Output, E>

The resulting type after applying the + operator.

fn add(self, other: Validated<T2, E>) -> Self::Output

Performs the + operation.

impl<T: Debug, E: Debug> Debug for Validated<T, E> where
    T: HList, 

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

Formats the value using the given formatter.