| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Cardano.CLI.Vary.Utils
Synopsis
- type (:|) (e :: k) (es :: [k]) = Member e es
- class KnownPrefix es => Subset (xs :: [Type]) (es :: [Type]) where
- type Mappable a b (xs :: [Type]) (ys :: [Type]) = (a :| xs, b :| ys, ys ~ Mapped a b xs)
- type family Length (xs :: [k]) :: Nat where ...
- type Index (n :: Nat) (l :: [k]) = Type_List_Too_Vague___Please_Specify_Prefix_Of_List_Including_The_Desired_Type's_Location n l l
- type IndexOf (x :: k) (xs :: [k]) = IndexOf' (MaybeIndexOf x xs) x xs
- pop :: forall a (as :: [Type]). Vary (a ': as) -> Either (Vary as) a
- size :: forall (xs :: [Type]). KnownNat (Length xs) => Vary xs -> Word
- activeIndex :: forall (a :: [Type]). Vary a -> Word
- natValue :: forall (n :: Nat) a. (KnownNat n, Num a) => a
Documentation
This module contains functions and typeclasses/type families (type-level functions) that are not useful in every day usage, but are sometimes _very_ useful in:
- highly generic code
- When you want to implement typeclasses for
Vary. - When you want to have access to the internals of Vary to debug something
Useful in generic code and when implementing typeclasses
type (:|) (e :: k) (es :: [k]) = Member e es Source #
Constrain es to be any type list containing e.
Useful to talk about variants generically without having to specify the exact type list right away.
For instance, the type of from is
Vary.from :: (a :| l) => a -> Vary l
because we can use it to construct any Vary as long as there is an a somewhere in its list of types.
class KnownPrefix es => Subset (xs :: [Type]) (es :: [Type]) where Source #
Minimal complete definition
Nothing
Methods
subsetFullyKnown :: Bool Source #
morph' :: forall (ys :: [Type]). Vary xs -> Vary ys Source #
type Mappable a b (xs :: [Type]) (ys :: [Type]) = (a :| xs, b :| ys, ys ~ Mapped a b xs) Source #
Constraint to link the input and output lists together, without specifying any particular element order.
This allows us to defer type signatures until the final place the variant is used.
type family Length (xs :: [k]) :: Nat where ... Source #
Type-level function to compute the length of a type-level list
Equations
| Length (xs :: [k]) = Length' 0 xs |
type Index (n :: Nat) (l :: [k]) = Type_List_Too_Vague___Please_Specify_Prefix_Of_List_Including_The_Desired_Type's_Location n l l Source #
Given a type-level index, look up the type at that index.
If you ever see the Type_List_Too_Vague... in a type error,
it means that you need to make the (prefix) of the list of types more concrete
by adding some type annotations somewhere.
type IndexOf (x :: k) (xs :: [k]) = IndexOf' (MaybeIndexOf x xs) x xs Source #
Look up the index a particular type has in a type-level-list.
This index is what is used to determine the tag value stored in a Vary.
pop :: forall a (as :: [Type]). Vary (a ': as) -> Either (Vary as) a Source #
Attempts to extract a value of the first type from the Vary.
If this failed, we know it has to be one of the other possibilities.
This function can also be seen as turning one layer of Vary into its isomorphic Either representation.
This function is not often useful in normal code, but super useful in generic code where you want to recurse on the variant's types.
For instance when implementing a typeclass for any Vary whose elements implement the typeclass:
instance Show (Vary '[]) where
show = Vary.exhaustiveCase
instance (Show a, Show (Vary as)) => Show (Vary (a : as)) where
show vary = case Vary.pop vary of
Right val -> "Vary.from " <> show val
Left other -> show otherTo go the other way:
Informational (for Debugging)
size :: forall (xs :: [Type]). KnownNat (Length xs) => Vary xs -> Word Source #
Returns the number of elements contained in this variant.
Does not actually use the runtime representation of the variant in any way.
activeIndex :: forall (a :: [Type]). Vary a -> Word Source #
Returns the currently active 'tag index' of the variant.
Not useful in normal code, but maybe nice in certaing debugging scenarios.
Note that this index changes whenever a variant is morphed.