Language.KURE.Injection

This module provides a type class for injective functions (and their projections), and some useful interactions with Transform.

Injection Class

class Injection a b where

A class of injective functions from a to b, and their projections. The following law is expected to hold:

project (inject a) == Just a

Methods

inject :: a -> b

project :: b -> Maybe a

Instances

Injection a a

There is an identity injection for all types.

Injection a (Maybe a)

Monad Injections

injectM :: (Monad m, Injection a g) => a -> m g

Injects a value and lifts it into a Monad.

projectM :: (Monad m, Injection a g) => g -> m a

Projects a value and lifts it into a Monad, with the possibility of failure.

projectWithFailMsgM :: (Monad m, Injection a g) => String -> g -> m a

As projectM, but takes a custom error message to use if projection fails.

Transformation Injections

injectT :: (Monad m, Injection a g) => Transform c m a g

Lifted inject.

projectT :: (Monad m, Injection a g) => Transform c m g a

Lifted project, the transformation fails if the projection fails.

extractT :: (Monad m, Injection a g) => Transform c m g b -> Transform c m a b

Convert a transformation over an injected value into a transformation over a non-injected value.

promoteT :: (Monad m, Injection a g) => Transform c m a b -> Transform c m g b

Promote a transformation over a value into a transformation over an injection of that value, (failing if that injected value cannot be projected).

promoteWithFailMsgT :: (Monad m, Injection a g) => String -> Transform c m a b -> Transform c m g b

As promoteT, but takes a custom error message to use if promotion fails.

Rewrite Injections

extractR :: (Monad m, Injection a g) => Rewrite c m g -> Rewrite c m a

Convert a rewrite over an injected value into a rewrite over a projection of that value, (failing if that injected value cannot be projected).

promoteR :: (Monad m, Injection a g) => Rewrite c m a -> Rewrite c m g

Promote a rewrite over a value into a rewrite over an injection of that value, (failing if that injected value cannot be projected).

extractWithFailMsgR :: (Monad m, Injection a g) => String -> Rewrite c m g -> Rewrite c m a

As extractR, but takes a custom error message to use if extraction fails.

promoteWithFailMsgR :: (Monad m, Injection a g) => String -> Rewrite c m a -> Rewrite c m g

As promoteR, but takes a custom error message to use if promotion fails.