Struct contrafact::Check

#[must_use = "Check should be used with either `.unwrap()` or `.result()`"]
pub struct Check { /* fields omitted */ }

The result of a check operation, which contains an error message for every constraint which was not met.

Implementations

impl Check

pub fn map<F>(self, f: F) -> Self where
    F: FnMut(String) -> String, 

Map over each error string. Useful for combinators which add additional context to errors produced by inner facts.

pub fn unwrap(self)

Panic if there are any errors, and display those errors.

pub fn is_ok(&self) -> bool

There are no errors.

pub fn is_err(&self) -> bool

There is at least one error.

pub fn result(self) -> Result<(), Vec<String>>

Convert to a Result: No errors => Ok

use contrafact::*;
assert_eq!(Check::pass().result(), Ok(()));
assert_eq!(Check::fail("message").result(), Err(vec!["message".to_string()]));

pub fn check<S: ToString>(ok: bool, err: S) -> Self

Create a single-error failure if predicate is false, otherwise pass

use contrafact::*;
assert_eq!(Check::check(true, "message"), Check::pass());
assert_eq!(Check::check(false, "message"), Check::fail("message"));

pub fn pass() -> Self

Create an ok result.

use contrafact::*;
assert_eq!(Check::pass(), vec![].into())

pub fn fail<S: ToString>(error: S) -> Self

Create a failure result with a single error.

use contrafact::*;
assert_eq!(Check::fail("message"), vec!["message".to_string()].into())

Trait Implementations

impl Clone for Check

fn clone(&self) -> Check

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Check

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

Formats the value using the given formatter.

impl From<Result<Check, Error>> for Check

fn from(result: Result<Check>) -> Check

Performs the conversion.

impl From<Vec<String, Global>> for Check

fn from(original: Vec<String>) -> Check

Performs the conversion.

impl Hash for Check

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, 

Feeds a slice of this type into the given Hasher.

impl IntoIterator for Check

type Item = <Vec<String> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <Vec<String> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Check> for Check

fn eq(&self, other: &Check) -> bool

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

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

This method tests for !=.

impl Eq for Check

impl StructuralEq for Check

impl StructuralPartialEq for Check