pub enum Validation<T, E> {
Success(T),
Failure(E),
}Expand description
A validation that either succeeds with a value or fails with accumulated errors
Unlike Result, Validation is designed to accumulate multiple errors when combining
validations. This makes it ideal for form validation, API input validation, and other
scenarios where you want to report all errors at once rather than failing on the first one.
§Type Parameters
T- The type of the success valueE- The type of the error value (must implementSemigroupfor accumulation)
§Examples
use stillwater::{Validation, Semigroup};
// Simple validation
let v = Validation::<_, Vec<&str>>::success(42);
assert_eq!(v.into_result(), Ok(42));
// Error accumulation
let v1 = Validation::<i32, _>::failure(vec!["error1"]);
let v2 = Validation::<i32, _>::failure(vec!["error2"]);
let combined = v1.and(v2);
assert_eq!(combined, Validation::Failure(vec!["error1", "error2"]));Variants§
Implementations§
Source§impl<T, E> Validation<T, E>
impl<T, E> Validation<T, E>
Sourcepub fn success(value: T) -> Validation<T, E>
pub fn success(value: T) -> Validation<T, E>
Create a successful validation
§Examples
use stillwater::Validation;
let v = Validation::<i32, String>::success(42);
assert!(v.is_success());Sourcepub fn failure(error: E) -> Validation<T, E>
pub fn failure(error: E) -> Validation<T, E>
Create a failed validation
§Examples
use stillwater::Validation;
let v = Validation::<i32, Vec<&str>>::failure(vec!["error"]);
assert!(v.is_failure());Sourcepub fn from_result(result: Result<T, E>) -> Validation<T, E>
pub fn from_result(result: Result<T, E>) -> Validation<T, E>
Create a validation from a Result
§Examples
use stillwater::Validation;
let v = Validation::from_result(Ok::<_, String>(42));
assert_eq!(v, Validation::Success(42));
let v = Validation::from_result(Err::<i32, _>("error".to_string()));
assert_eq!(v, Validation::Failure("error".to_string()));Sourcepub fn into_result(self) -> Result<T, E>
pub fn into_result(self) -> Result<T, E>
Convert this validation to a Result
§Examples
use stillwater::Validation;
let v = Validation::<_, String>::success(42);
assert_eq!(v.into_result(), Ok(42));
let v = Validation::<i32, _>::failure("error".to_string());
assert_eq!(v.into_result(), Err("error".to_string()));Sourcepub fn is_success(&self) -> bool
pub fn is_success(&self) -> bool
Check if this validation is successful
§Examples
use stillwater::Validation;
let v = Validation::<_, String>::success(42);
assert!(v.is_success());Sourcepub fn is_failure(&self) -> bool
pub fn is_failure(&self) -> bool
Check if this validation failed
§Examples
use stillwater::Validation;
let v = Validation::<i32, _>::failure("error".to_string());
assert!(v.is_failure());Sourcepub fn map<U, F>(self, f: F) -> Validation<U, E>where
F: FnOnce(T) -> U,
pub fn map<U, F>(self, f: F) -> Validation<U, E>where
F: FnOnce(T) -> U,
Transform the success value if present
§Examples
use stillwater::Validation;
let v = Validation::<_, String>::success(5);
let result = v.map(|x| x * 2);
assert_eq!(result, Validation::Success(10));Sourcepub fn map_err<E2, F>(self, f: F) -> Validation<T, E2>where
F: FnOnce(E) -> E2,
pub fn map_err<E2, F>(self, f: F) -> Validation<T, E2>where
F: FnOnce(E) -> E2,
Transform the error value if present
§Examples
use stillwater::Validation;
let v = Validation::<i32, _>::failure(vec!["error"]);
let result = v.map_err(|errors| errors.len());
assert_eq!(result, Validation::Failure(1));Source§impl<T, E> Validation<T, NonEmptyVec<E>>
impl<T, E> Validation<T, NonEmptyVec<E>>
Sourcepub fn fail(error: E) -> Validation<T, NonEmptyVec<E>>
pub fn fail(error: E) -> Validation<T, NonEmptyVec<E>>
Create a failure with a single error.
This is a convenience method for creating validations that fail with a single error, without needing to construct a NonEmptyVec explicitly.
§Examples
use stillwater::{Validation, NonEmptyVec};
let v = Validation::<i32, NonEmptyVec<&str>>::fail("error");
assert!(v.is_failure());Source§impl<T, E> Validation<T, E>where
E: Semigroup,
impl<T, E> Validation<T, E>where
E: Semigroup,
Sourcepub fn and<U>(self, other: Validation<U, E>) -> Validation<(T, U), E>
pub fn and<U>(self, other: Validation<U, E>) -> Validation<(T, U), E>
Combine two validations, accumulating errors using the Semigroup instance
If both validations are successful, returns a success with a tuple of both values.
If either or both fail, accumulates the errors using Semigroup::combine.
§Examples
use stillwater::Validation;
// Both successful
let v1 = Validation::<_, Vec<&str>>::success(1);
let v2 = Validation::<_, Vec<&str>>::success(2);
assert_eq!(v1.and(v2), Validation::Success((1, 2)));
// Both failed - errors accumulate
let v1 = Validation::<i32, _>::failure(vec!["error1"]);
let v2 = Validation::<i32, _>::failure(vec!["error2"]);
assert_eq!(v1.and(v2), Validation::Failure(vec!["error1", "error2"]));Sourcepub fn and_then<U, F>(self, f: F) -> Validation<U, E>where
F: FnOnce(T) -> Validation<U, E>,
pub fn and_then<U, F>(self, f: F) -> Validation<U, E>where
F: FnOnce(T) -> Validation<U, E>,
Chain a dependent validation
Similar to Result::and_then, but for validations. The function is only called
if the current validation is successful.
§Examples
use stillwater::Validation;
let v = Validation::<_, Vec<&str>>::success(5);
let result = v.and_then(|x| {
if x > 0 {
Validation::success(x * 2)
} else {
Validation::failure(vec!["must be positive"])
}
});
assert_eq!(result, Validation::Success(10));Sourcepub fn all_vec(validations: Vec<Validation<T, E>>) -> Validation<Vec<T>, E>
pub fn all_vec(validations: Vec<Validation<T, E>>) -> Validation<Vec<T>, E>
Combine all validations in a Vec
Returns a success with a Vec of all success values if all validations succeed.
Otherwise, accumulates all errors using Semigroup::combine.
§Examples
use stillwater::Validation;
let validations = vec![
Validation::<_, Vec<&str>>::success(1),
Validation::<_, Vec<&str>>::success(2),
Validation::<_, Vec<&str>>::success(3),
];
let result = Validation::all_vec(validations);
assert_eq!(result, Validation::Success(vec![1, 2, 3]));
let validations = vec![
Validation::<i32, _>::failure(vec!["error1"]),
Validation::<i32, _>::failure(vec!["error2"]),
];
let result = Validation::all_vec(validations);
assert_eq!(result, Validation::Failure(vec!["error1", "error2"]));Source§impl<T, E> Validation<T, E>
impl<T, E> Validation<T, E>
Sourcepub fn all<V, E2>(
validations: V,
) -> Validation<<V as ValidateAll<E2>>::Output, E2>where
E2: Semigroup,
V: ValidateAll<E2>,
pub fn all<V, E2>(
validations: V,
) -> Validation<<V as ValidateAll<E2>>::Output, E2>where
E2: Semigroup,
V: ValidateAll<E2>,
Combine all validations in a tuple
This is a convenience method that delegates to the ValidateAll trait.
It works with tuples of validations up to size 12.
§Examples
use stillwater::{Validation, validation::ValidateAll};
let result = (
Validation::<_, Vec<&str>>::success(1),
Validation::<_, Vec<&str>>::success(2),
Validation::<_, Vec<&str>>::success(3),
).validate_all();
assert_eq!(result, Validation::Success((1, 2, 3)));Trait Implementations§
Source§impl<T, E> Clone for Validation<T, E>
impl<T, E> Clone for Validation<T, E>
Source§fn clone(&self) -> Validation<T, E>
fn clone(&self) -> Validation<T, E>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<T, E> Debug for Validation<T, E>
impl<T, E> Debug for Validation<T, E>
Source§impl<T, E> PartialEq for Validation<T, E>
impl<T, E> PartialEq for Validation<T, E>
impl<T, E> Eq for Validation<T, E>
impl<T, E> StructuralPartialEq for Validation<T, E>
Auto Trait Implementations§
impl<T, E> Freeze for Validation<T, E>
impl<T, E> RefUnwindSafe for Validation<T, E>where
T: RefUnwindSafe,
E: RefUnwindSafe,
impl<T, E> Send for Validation<T, E>
impl<T, E> Sync for Validation<T, E>
impl<T, E> Unpin for Validation<T, E>
impl<T, E> UnwindSafe for Validation<T, E>where
T: UnwindSafe,
E: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.