tagged- Provides newtype wrappers for phantom types to avoid unsafely passing dummy arguments

Portabilitygeneralized newtype deriving
MaintainerEdward Kmett <ekmett@gmail.com>






Tagged values

newtype Tagged s b Source

A Tagged s b value is a value b with an attached phantom type s. This can be used in place of the more traditional but less safe idiom of passing in an undefined value with the type, because unlike an (s -> b), a Tagged s b can't try to use the argument s as a real value.

Moreover, you don't have to rely on the compiler to inline away the extra argument, because the newtype is free




unTagged :: b


Typeable2 Tagged 
Monad (Tagged s) 
Functor (Tagged s) 
Applicative (Tagged s) 
Foldable (Tagged s) 
Traversable (Tagged s) 
Bounded b => Bounded (Tagged s b) 
Enum b => Enum (Tagged s b) 
Eq b => Eq (Tagged s b) 
Floating b => Floating (Tagged s b) 
Fractional b => Fractional (Tagged s b) 
Integral b => Integral (Tagged s b) 
(Data s, Data b) => Data (Tagged s b) 
Num b => Num (Tagged s b) 
Ord b => Ord (Tagged s b) 
Read b => Read (Tagged s b) 
Real b => Real (Tagged s b) 
RealFloat b => RealFloat (Tagged s b) 
RealFrac b => RealFrac (Tagged s b) 
Show b => Show (Tagged s b) 
Ix b => Ix (Tagged s b) 
Semigroup a => Semigroup (Tagged s a) 

retag :: Tagged s b -> Tagged t bSource

Some times you need to change the tag you have lying around. Idiomatic usage is to make a new combinator for the relationship between the tags that you want to enforce, and define that combinator using retag.

 data Succ n
 retagSucc :: Tagged n a -> Tagged (Succ n) a
 retagSucc = retag

untag :: Tagged s b -> bSource

Alias for unTagged

tagSelf :: a -> Tagged a aSource

Tag a value with its own type.

untagSelf :: Tagged a a -> aSource

untagSelf is a type-restricted version of untag.

asTaggedTypeOf :: s -> Tagged s b -> sSource

asTaggedTypeOf is a type-restricted version of const. It is usually used as an infix operator, and its typing forces its first argument (which is usually overloaded) to have the same type as the tag of the second.