Data.Refined

newtype Refined p x

Constructors

• Refined x

Instances

• (Eq x) => Eq (Refined p x)
• (Show x) => Show (Refined p x)
• (Ord x) => Ord (Refined p x)
• Generic (Refined p x) _
• (DecodeJson x, Show x, Predicate p x) => DecodeJson (Refined p x)

  for decoding we first decode the thing inside, then run our predicate on it

• (EncodeJson x) => EncodeJson (Refined p x)

  for encoding we just want to strip away the outside layer and use whatever is inside

• (Arbitrary a, Predicate p a) => Arbitrary (Refined p a)

  create an Arbitrary instance by randomly throwing values against the wall until something sticks

refine :: forall p x. Predicate p x => x -> Either (RefinedError x) (Refined p x)

unsafeRefine :: forall p x. Predicate p x => x -> (Refined p x)

unrefine :: forall p x. Refined p x -> x

data RefinedError a

Constructors

• AndError (These (RefinedError a) (RefinedError a))
• OrError (RefinedError a) (RefinedError a)
• SizeEqualToError Int a
• SizeGreaterThanError Int a
• SizeLessThanError Int a
• NotError
• LessThanError Int a
• GreaterThanError Int a
• FromError Int a
• ToError Int a
• FromToError Int Int a
• EqualToError Int a
• NotEqualToError Int a

Instances

• (Eq a) => Eq (RefinedError a)
• (Show a) => Show (RefinedError a)

data These a b

Helper version of function because i am too lazy to find the package

Constructors

• This a
• That b
• These a b

Instances

• (Eq a, Eq b) => Eq (These a b)
• (Ord a, Ord b) => Ord (These a b)

fromInt :: forall a. Ring a => Int -> a

type ZeroToOne = FromTo D0 D1

An inclusive range of values from zero to one.

data To n

A 'Predicate' ensuring that the value is up and including a given int

Instances

• (Nat n, Ord x, Ring x) => Predicate (To n) x

data SizeLessThan a

A 'Predicate' ensuring that the length of a foldable is less than a given int

Instances

• (Predicate a x, Foldable t, Nat n) => Predicate (SizeLessThan n) (t a)

data SizeGreaterThan a

A 'Predicate' ensuring that the length of a foldable is greater than a given int

Instances

• (Predicate a x, Foldable t, Nat n) => Predicate (SizeGreaterThan n) (t a)

data SizeEqualTo a

A 'Predicate' ensuring that the length of a foldable is equal to a given int

Instances

• (Predicate a x, Foldable t, Nat n) => Predicate (SizeEqualTo n) (t a)

type Positive = GreaterThan D0

A 'Predicate' ensuring that the value is greater than zero.

data Or l r

A 'Predicate' ensuring that one of two given Predicates is valid

Instances

• (Predicate l x, Predicate r x) => Predicate (Or l r) x

data NotEqualTo n

A 'Predicate' ensuring that the value is not equal to a given int

Instances

• (Nat n, Eq x, Ring x) => Predicate (NotEqualTo n) x

data Not a

A 'Predicate' ensuring that the opposite of another Predicate passes

Instances

• (Predicate a x) => Predicate (Not a) x

type NonZero = NotEqualTo D0

A 'Predicate' ensuring that the value is not equal to zero.

type NonNegative = From D0

A 'Predicate' ensuring that the value is greater than or equal to zero.

type NonEmpty = SizeGreaterThan D0

A 'Predicate' ensuring that the 'Foldable' is non-empty.

type Negative = LessThan D0

A 'Predicate' ensuring that the value is less than zero.

data LessThan n

A 'Predicate' ensuring that the value is less than a given int

Instances

• (Nat n, Ord x, Ring x) => Predicate (LessThan n) x

data IdPred

A 'Predicate' for which everything is valid

Instances

• Predicate IdPred x

data GreaterThan n

A 'Predicate' ensuring that the value is greater than a given int

Instances

• (Nat n, Ord x, Ring x) => Predicate (GreaterThan n) x

data FromTo m n

A 'Predicate' ensuring that the value is between two given ints (inclusive)

Instances

• (Nat n, Nat m, Ord x, Ring x) => Predicate (FromTo m n) x

data From n

A 'Predicate' ensuring that the value is equal to or greater than a given int

Instances

• (Nat n, Ord x, Ring x) => Predicate (From n) x

data EqualTo n

A 'Predicate' ensuring that the value is equal to a given int

Instances

• (Nat n, Eq x, Ring x) => Predicate (EqualTo n) x

data And l r

A 'Predicate' ensuring that both given Predicates are valid

Instances

• (Predicate l x, Predicate r x) => Predicate (And l r) x

class Predicate p x  where

Members

• validate :: p -> x -> Either (RefinedError x) x

Instances

• Predicate IdPred x
• (Predicate l x, Predicate r x) => Predicate (And l r) x
• (Predicate l x, Predicate r x) => Predicate (Or l r) x
• (Predicate a x, Foldable t, Nat n) => Predicate (SizeEqualTo n) (t a)
• (Predicate a x, Foldable t, Nat n) => Predicate (SizeGreaterThan n) (t a)
• (Predicate a x, Foldable t, Nat n) => Predicate (SizeLessThan n) (t a)
• (Predicate a x) => Predicate (Not a) x
• (Nat n, Ord x, Ring x) => Predicate (LessThan n) x
• (Nat n, Ord x, Ring x) => Predicate (GreaterThan n) x
• (Nat n, Ord x, Ring x) => Predicate (From n) x
• (Nat n, Ord x, Ring x) => Predicate (To n) x
• (Nat n, Nat m, Ord x, Ring x) => Predicate (FromTo m n) x
• (Nat n, Eq x, Ring x) => Predicate (EqualTo n) x
• (Nat n, Eq x, Ring x) => Predicate (NotEqualTo n) x