A refinement type, which wraps a value of type x, ensuring that it satisfies a type-level predicate p.

The only ways that this library provides to construct a value of type Refined are with the 'refine-' family of functions, because the use of the newtype constructor gets around the checking of the predicate. This restriction on the user makes unrefine safe.

If you would really like to construct a Refined value without checking the predicate, use unsafeCoerce.

A smart constructor of a Refined value. Checks the input value at runtime.

Constructs a Refined value at run-time, calling throwM if the value does not satisfy the predicate.

Constructs a Refined value at run-time, calling fail if the value does not satisfy the predicate.

Constructs a Refined value at run-time, calling throwError if the value does not satisfy the predicate.

Constructs a Refined value at run-time, calling error if the value does not satisfy the predicate.

WARNING: this function is not total!

Constructs a Refined value at compile-time using -XTemplateHaskell.

For example:

>>> $$(refineTH 23) :: Refined Positive Int
Refined 23

Here's an example of an invalid value:

>>> $$(refineTH 0) :: Refined Positive Int
<interactive>:6:4:
    Value is not greater than 0
    In the Template Haskell splice $$(refineTH 0)
    In the expression: $$(refineTH 0) :: Refined Positive Int
    In an equation for ‘it’:
        it = $$(refineTH 0) :: Refined Positive Int

If it's not evident, the example above indicates a compile-time failure, which means that the checking was done at compile-time, thus introducing a zero runtime overhead compared to a plain value construction.

Extracts the refined value.

A typeclass which defines a runtime interpretation of a type-level predicate p for type x.

The negation of a predicate.

The conjunction of two predicates.

The conjunction of two predicates.

The disjunction of two predicates.

The disjunction of two predicates.

A Predicate ensuring that the value is less than the specified type-level number.

A Predicate ensuring that the value is greater than the specified type-level number.

A Predicate ensuring that the value is greater than or equal to the specified type-level number.

A Predicate ensuring that the value is less than or equal to the specified type-level number.

A Predicate ensuring that the value is within an inclusive range.

A Predicate ensuring that the value is equal to the specified type-level number n.

A Predicate ensuring that the value is not equal to the specified type-level number n.

A Predicate ensuring that the value is greater than zero.

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

A Predicate ensuring that the value is less than zero.

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

An inclusive range of values from zero to one.

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

A Predicate ensuring that the Foldable has a length which is less than the specified type-level number.

A Predicate ensuring that the Foldable has a length which is greater than the specified type-level number.

A Predicate ensuring that the Foldable has a length which is equal to the specified type-level number.

A Predicate ensuring that the Foldable is non-empty.

A Predicate ensuring that the IsList contains elements in a strictly ascending order.

A Predicate ensuring that the IsList contains elements in a strictly descending order.

A typeclass containing "safe" conversions between refined predicates where the target is weaker than the source: that is, all values that satisfy the first predicate will be guarunteed to satisy the second.

Take care: writing an instance declaration for your custom predicates is the same as an assertion that weaken is safe to use:

instance Weaken Pred1 Pred2

For most of the instances, explicit type annotations for the result value's type might be required.

This function helps type inference. It is equivalent to the following:

instance Weaken (And l r) l

This function helps type inference. It is equivalent to the following:

instance Weaken (And l r) r

This function helps type inference. It is equivalent to the following:

instance Weaken l (Or l r)

This function helps type inference. It is equivalent to the following:

instance Weaken r (Or l r)

An exception encoding the way in which a Predicate failed.

Display a RefineException as a Doc ann

A monad transformer that adds RefineExceptions to other monads.

The pure and return functions yield computations that produce the given value, while >>= sequences two subcomputations, exiting on the first RefineException.

The inverse of RefineT.

Map the unwrapped computation using the given function.

runRefineT (mapRefineT f m) = f (runRefineT m)

RefineM a is equivalent to RefineT Identity a for any type a.

Constructs a computation in the RefineM monad. (The inverse of runRefineM).

Run a monadic action of type RefineM a, yielding an Either RefineException a.

This is just defined as runIdentity . runRefineT.

One can use throwRefine inside of a monadic context to begin processing a RefineException.

A handler function to handle previous RefineExceptions and return to normal execution. A common idiom is:

 do { action1; action2; action3 } `catchRefine' handler

where the action functions can call throwRefine. Note that handler and the do-block must have the same return type.

A handler for a RefineException.

throwRefineOtherException is useful for defining what behaviour validate should have in the event of a predicate failure.