Keuringsdienst

Core types

type ValidationResult = Validation [ErrMsg]

ValidationResult is the data type of choice for now, since we have chosen to implement the library in a way that it will return a [Text] as context for validation failures.

newtype ValidationRule a

Data type representing a composable validation rule to be applied on a certain data.

Constructors

ValidationRule

Fields

• performValidation :: a -> ValidationResult

Instances

Monoid (ValidationRule a)

Defined in Keuringsdienst

Methods

mempty :: ValidationRule a

mappend :: ValidationRule a -> ValidationRule a -> ValidationRule a

mconcat :: [ValidationRule a] -> ValidationRule a

Semigroup (ValidationRule x)

Defined in Keuringsdienst

Methods

(<>) :: ValidationRule x -> ValidationRule x -> ValidationRule x

sconcat :: NonEmpty (ValidationRule x) -> ValidationRule x

stimes :: Integral b => b -> ValidationRule x -> ValidationRule x

data Validation err

Core data type representing the outcome of a validation, which can be a success, or a failure with more information about the failure.

Constructors

Success

Failure err

Instances

Monoid ValidationResult

Defined in Keuringsdienst

Methods

mempty :: ValidationResult

mappend :: ValidationResult -> ValidationResult -> ValidationResult

mconcat :: [ValidationResult] -> ValidationResult

Semigroup ValidationResult

Defined in Keuringsdienst

Methods

(<>) :: ValidationResult -> ValidationResult -> ValidationResult

sconcat :: NonEmpty ValidationResult -> ValidationResult

stimes :: Integral b => b -> ValidationResult -> ValidationResult

FromJSON err => FromJSON (Validation err)

Defined in Keuringsdienst

Methods

parseJSON :: Value -> Parser (Validation err)

parseJSONList :: Value -> Parser [Validation err]

omittedField :: Maybe (Validation err)

ToJSON err => ToJSON (Validation err)

Defined in Keuringsdienst

Methods

toJSON :: Validation err -> Value

toEncoding :: Validation err -> Encoding

toJSONList :: [Validation err] -> Value

toEncodingList :: [Validation err] -> Encoding

omitField :: Validation err -> Bool

Generic (Validation err)

Defined in Keuringsdienst

Associated Types

type Rep (Validation err) :: Type -> Type

Methods

from :: Validation err -> Rep (Validation err) x

to :: Rep (Validation err) x -> Validation err

Show err => Show (Validation err)

Defined in Keuringsdienst

Methods

showsPrec :: Int -> Validation err -> ShowS

show :: Validation err -> String

showList :: [Validation err] -> ShowS

Eq err => Eq (Validation err)

Defined in Keuringsdienst

Methods

(==) :: Validation err -> Validation err -> Bool

(/=) :: Validation err -> Validation err -> Bool

type Rep (Validation err)

Defined in Keuringsdienst

type Rep (Validation err) = D1 ('MetaData "Validation" "Keuringsdienst" "keuringsdienst-1.0.0.5-Lton8bqyV7MHpHGzg2LYfC" 'False) (C1 ('MetaCons "Success" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Failure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 err)))

Operators

keuren :: a -> ValidationRule a -> ValidationResult

This function applies a validation rule to a value. Stands for validate/judge in Dutch.

misschienKeuren :: Maybe a -> ValidationRule a -> ValidationResult

This function applies a validation rule to a value when it is a Just and defaults to a Success in case of a Nothing. Stands for maybe validate/judge in Dutch.

validate :: a -> ValidationRule a -> ValidationResult

Alias to the keuren operator

maybeValidate :: Maybe a -> ValidationRule a -> ValidationResult

Alias to the misschienKeuren operator

ofDitOfDat :: ValidationRule a -> ValidationRule a -> ValidationRule a

If one of the validations has a successful result, then the validation is a success. Stands for or this or that in Dutch.

orThisOrThat :: ValidationRule a -> ValidationRule a -> ValidationRule a

Alias to the ofDitOfDat operator

(*||*) :: ValidationRule a -> ValidationRule a -> ValidationRule a infixl 6

ofDitOfDat operator

(|??|) :: Maybe a -> ValidationRule a -> ValidationResult infixl 8

misschienKeuren operator

(|?|) :: a -> ValidationRule a -> ValidationResult infixl 8

keuren operator