The validation package

[Tags: bsd3, library]

Several data-types like Either but with differing properties and type-class instances.

Library support is provided for those different representations, include lens-related functions for converting between each and abstracting over their similarities.

The AccValidation data type is isomorphic to Either, but has an instance of Applicative that accumulates on the error side. That is to say, if two (or more) errors are encountered, they are appended using a Semigroup operation.

As a consequence of this Applicative instance, there is no corresponding Bind or Monad instance. AccValidation is an example of, An applicative functor that is not a monad.

The Validation data type is isomorphic to Either and has a Monad instance that does the same as Either. The only difference to Either is the constructor names and surrounding library support.

The ValidationT data type is the monad transformer for Validation. An instance of MonadTrans is provided for `(ValidationT err)`. Due to the arrangement of the ValidationT type constructor, which permits a `MonadTrans instance, there is no possible Bifunctor instance. Consequently, the ValidationB data type provides a Bifunctor instance (but not a MonadTrans instance). Library support is provided to exploit the isomorphism to ValidationB.

Note that since AccValidation is not a monad, there is also no corresponding monad transformer for this data type.

The ValidationB data type is similar to the monad transformer for Validation (ValidationT), however, due to the arrangement of the ValidationB type constructor, which permits a Bifunctor instance, there is no possible MonadTrans instance. Consequently, the ValidationT data type provides a MonadTrans instance (but not a Bifunctor instance). Library support is provided to exploit the isomorphism to ValidationT.

The Validation err a` type-alias is equivalent to `ValidationT err Identity a` and so is isomorphic to Either and others. Libraries are supplied accordingly.

Properties

Versions0.3.0, 0.3.1, 0.3.2, 0.3.3, 0.3.4, 0.4.0, 0.4.1, 0.4.2, 0.4.3, 0.5.0, 0.5.1
Change logchangelog
Dependenciesbase (>=3 && <5), bifunctors (>=3.0), lens (>=4.0 && <5), mtl (>=2.0 && <2.3), semigroupoids (>=4.0), semigroups (>=0.8), transformers (>=0.3 && <0.5) [details]
LicenseBSD3
CopyrightCopyright (C) 2014,2015 NICTA Limited
AuthorTony Morris <ʇǝu˙sıɹɹoɯʇ@ןןǝʞsɐɥ> <dibblego>, Nick Partridge <nkpart>
MaintainerTony Morris <ʇǝu˙sıɹɹoɯʇ@ןןǝʞsɐɥ> <dibblego>, Nick Partridge <nkpart>
CategoryData
Home pagehttps://github.com/NICTA/validation
Bug trackerhttps://github.com/NICTA/validation/issues
Source repositoryhead: git clone git@github.com:NICTA/validation.git
UploadedTue Feb 17 06:30:49 UTC 2015 by TonyMorris
DistributionsNixOS:0.5.1
Downloads1911 total (125 in last 30 days)
Votes
0 []
StatusDocs available [build log]
Last success reported on 2015-02-17 [all 1 reports]

Modules

[Index]

Flags

NameDescriptionDefault
small_baseChoose the new, split-up base package.Enabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainers' corner

For package maintainers and hackage trustees