Data.Diverse.Lens.Which

Single type

Prism

class AsFacet a s where

pick (review facet) and trial (preview facet) in Prism' form.

facet = prism' pick (trial')

let y = review (facet @Int) (5 :: Int) :: Which '[Bool, Int, Char, Bool, Char] -- pick
    x = preview (facet @Int) y -- trial
x `shouldBe` (Just 5)

Methods

facet :: Prism' s a

Make it easy to create an instance of AsFacet using Typed

facet :: AsType a s => Prism' s a

Make it easy to create an instance of AsFacet using Typed

Instances

UniqueMember * x xs => AsFacet x (Which xs)

Methods

facet :: Prism' (Which xs) x

class AsFacet a s => MatchingFacet a s t | s a -> t where

Minimal complete definition

matchingFacet

Methods

matchingFacet :: s -> Either t a

Unfortunately, polymorphic Prism s t a b cannot be used as it can only be created with: (UniqueMember x xs, UniqueMember y ys, ys ~ Remove x xs) => prism (pick :: y -> Which ys) (trial :: Which xs -> Either (Which ys) x) This above causes problems when used monomorphically with s ~ t and x ~ y since xs cannot equal ys ~ Remove x x.

What is desirec is: (UniqueMember x xs, ys ~ Remove x xs) => prism_ (pick :: x -> Which xs) (trial :: Which xs -> Either (Which ys) x)

So we expose the polymorhpic matching explicitly.

Instances

(UniqueMember * x xs, (~) [*] ys (Remove * x xs)) => MatchingFacet x (Which xs) (Which ys)

Methods

matchingFacet :: Which xs -> Either (Which ys) x

class AsFacetL (l :: k) a s | s l -> a where

pickL (review facetL) and trialL' (preview facetL') in Prism' form.

let y = review facetL @Bar (Tagged (5 :: Int)) :: Which '[Tagged Foo Bool, Tagged Bar Int, Char, Bool, Char]
    x = preview facetL @Bar y
x `shouldBe` (Just (Tagged 5))

Minimal complete definition

facetL

Methods

facetL :: Prism' s a

Instances

(UniqueLabelMember k * l xs, (~) * x (KindAtLabel k * l xs)) => AsFacetL k l x (Which xs)

Methods

facetL :: Prism' s (Which xs)

class AsFacetL l a s => MatchingFacetL l a s t | s a -> t where

Labelled version of MatchingFacet

Minimal complete definition

matchingFacetL

Methods

matchingFacetL :: s -> Either t a

Instances

(UniqueLabelMember k * l xs, (~) * x (KindAtLabel k * l xs), (~) [*] ys (Remove * x xs)) => MatchingFacetL k l x (Which xs) (Which ys)

Methods

matchingFacetL :: Which ys -> Either t (Which xs)

class AsFacetTag (l :: k) a s | s l -> a where

Variation of fetchL specialized to Tagged which automatically tags and untags the field. A default implementation using generics is not provided as it make GHC think that l must be type Symbol when l can actually be any kind. Create instances of AsFacetTag' using Data.Generics.Sum.Constructors as follows: instance AsConstructor' l Foo Foo a a => AsFacetTag l a Foo where facetTag = _Ctor l @

Minimal complete definition

facetTag

Methods

facetTag :: Prism' s a

Instances

(UniqueLabelMember k * l xs, (~) * (Tagged k l x) (KindAtLabel k * l xs)) => AsFacetTag k l x (Which xs)

Methods

facetTag :: Prism' s (Which xs)

class AsFacetTag l a s => MatchingFacetTag l a s t | l s a -> t where

Untagged version of MatchingFacet

Minimal complete definition

matchingFacetTag

Methods

matchingFacetTag :: s -> Either t a

Instances

(UniqueLabelMember k * l xs, (~) * (Tagged k l x) (KindAtLabel k * l xs), (~) [*] ys (Remove * (Tagged k l x) xs)) => MatchingFacetTag k l x (Which xs) (Which ys)

Methods

matchingFacetTag :: Which ys -> Either t (Which xs)

class AsFacetN (n :: Nat) a s | s n -> a where

pickN (review facetN) and trialN (preview facetN) in Prism' form.

facetN p = prism' (pickN p) (trialN' p)

let y = review (facetN @4) (5 :: Int) :: Which '[Bool, Int, Char, Bool, Int, Char] -- pickN
    x = preview (facetN @4) y -- trialN
x `shouldBe` (Just 5)

Minimal complete definition

facetN

Methods

facetN :: Prism' s a

Instances

MemberAt * n x xs => AsFacetN n x (Which xs)

Methods

facetN :: Prism' (Which xs) x

class AsFacetN n a s => MatchingFacetN n a s t | s a -> t where

Nat indexed version of MatchingFacet

Minimal complete definition

matchingFacetN

Methods

matchingFacetN :: s -> Either t a

Instances

(MemberAt * n x xs, (~) [*] ys (RemoveIndex * n xs)) => MatchingFacetN n x (Which xs) (Which ys)

Methods

matchingFacetN :: Which xs -> Either (Which ys) x

Multiple types

Prism

type Inject (branch :: [Type]) (tree :: [Type]) = (Diversify branch tree, Reinterpret' branch tree)

A friendlier constraint synonym for inject

inject :: forall branch tree. Inject branch tree => Prism' (Which tree) (Which branch)

diversify (review inject) and reinterpret' (preview inject) in Prism' form.

let x = pick (5 :: Int) :: Which '[String, Int]
    y = review (inject @_  @_ @[Bool, Int, Char, String]) x -- diversify
y `shouldBe` pick (5 :: Int) :: Which '[Bool, Int, Char, String]
let y' = preview (inject @_ @[String, Int]) y -- reinterpret
y' `shouldBe` Just (pick (5 :: Int)) :: Maybe (Which '[String, Int])

type InjectL (ls :: [k]) (branch :: [Type]) (tree :: [Type]) = (Diversify branch tree, Reinterpret' branch tree, branch ~ KindsAtLabels ls tree, UniqueLabels ls tree, IsDistinct ls)

A friendlier constraint synonym for injectL

injectL :: forall ls branch tree. InjectL ls branch tree => Prism' (Which tree) (Which branch)

diversifyL (review injectL) and reinterpretL' (preview injectL) in Prism' form.

let t = pick @[Tagged Bar Int, Tagged Foo Bool, Tagged Hi Char, Tagged Bye Bool] (5 :: Tagged Bar Int)
    b = pick @'[Tagged Foo Bool, Tagged Bar Int] (5 :: Tagged Bar Int)
    t' = review (injectL @_ @[Foo, Bar] @_ @[Tagged Bar Int, Tagged Foo Bool, Tagged Hi Char, Tagged Bye Bool]) b
    b' = preview (injectL @_ @[Foo, Bar]) t'
t `shouldBe` t'
b' `shouldBe` Just b

type InjectN (ns :: [Nat]) (branch :: [Type]) (tree :: [Type]) = (DiversifyN ns branch tree, ReinterpretN' ns branch tree)

A friendlier constraint synonym for injectN

injectN :: forall ns branch tree. InjectN ns branch tree => Prism' (Which tree) (Which branch)

diversifyN (review injectN) and reinterpretN' (preview injectN) in Prism' form.

let x = pick (5 :: Int) :: Which '[String, Int]
    y = review (injectN @_ @[3, 1] @_ @[Bool, Int, Char, String]) x -- diversifyN
y `shouldBe` pick (5 :: Int) :: Which '[Bool, Int, Char, String]
let y' = preview (injectN @_ @[3, 1] @[String, Int]) y -- reinterpertN'
y' `shouldBe` Just (pick (5 :: Int)) :: Maybe (Which '[String, Int])