Data.Validation.Semiring

newtype V err result

The V functor, used for alternative validation

The Alternative instance collects multiple failures in an arbitrary Semiring.

For example:

import Data.Semiring.Free

validate r :: Person -> V (Free Error) Person
validate person = { first: _, last: _, contact: _}
  <$> validateName person.first
  <*> validateName person.last
  <*> (validateEmail person.contact <|> validatePhone person.contact)

Constructors

• V (Either err result)

Instances

• Newtype (V err result) _
• (Eq err, Eq result) => Eq (V err result)
• (Eq err) => Eq1 (V err)
• (Ord err, Ord result) => Ord (V err result)
• (Ord err) => Ord1 (V err)
• (Show err, Show result) => Show (V err result)
• Functor (V err)
• Bifunctor V
• (Semiring err) => Apply (V err)
• (Semiring err) => Applicative (V err)
• (Semiring err, Semigroup a) => Semigroup (V err a)
• (Semiring err, Monoid a) => Monoid (V err a)
• (Semiring err) => Alt (V err)
• (Semiring err) => Plus (V err)
• Foldable (V err)
• Traversable (V err)

unV :: forall r result err. (err -> r) -> (result -> r) -> V err result -> r

Unpack the V type constructor, providing functions to handle the error and success cases.

invalid :: forall result err. err -> V err result

Fail with a validation error.

isValid :: forall result err. V err result -> Boolean

Test whether validation was successful or not.

toEither :: forall result err. V err result -> Either err result

andThen :: forall b a err. V err a -> (a -> V err b) -> V err b

Apply a function if successful, to enable chaining of validation.

Similar to a monadic bind, except it is inconsistent with Apply - that is, where as apply (V err a) (V err a) accumulates failures, (V err a) ``andThen`` (\a -> V err a) has fail-fast semantics (>>= would be expected to be consistent).