Safe Haskell	None
Language	Haskell2010

Data.Schematic.Lens

Synopsis

type family FIndex (r :: Symbol) (rs :: [(Symbol, Schema)]) :: Nat where ...
class i ~ FIndex fn rs => FElem (fn :: Symbol) (rs :: [(Symbol, Schema)]) (i :: Nat) where
- type ByField fn rs i :: Schema
type family FImage (rs :: [(Symbol, Schema)]) (ss :: [(Symbol, Schema)]) :: [Nat] where ...
class is ~ FImage rs ss => FSubset (rs :: [(Symbol, Schema)]) (ss :: [(Symbol, Schema)]) is where
obj :: Iso' (JsonRepr (SchemaObject fields)) (Rec FieldRepr fields)
arr :: Iso' (JsonRepr (SchemaArray cs schema)) (Vector (JsonRepr schema))
uni :: Iso' (JsonRepr (SchemaUnion (h ': tl))) (Union JsonRepr (h ': tl))
txt :: Iso' (JsonRepr (SchemaText cs)) Text
num :: Iso' (JsonRepr (SchemaNumber cs)) Scientific
opt :: Iso' (JsonRepr (SchemaOptional schema)) (Maybe (JsonRepr schema))
bln :: Iso' (JsonRepr SchemaBoolean) Bool
textRepr :: (KnownSymbol fn, SingI cs) => Iso' (FieldRepr '(fn, SchemaText cs)) Text
numberRepr :: (KnownSymbol fn, SingI cs) => Iso' (FieldRepr '(fn, SchemaNumber cs)) Scientific
boolRepr :: KnownSymbol fn => Iso' (FieldRepr '(fn, SchemaBoolean)) Bool
arrayRepr :: (KnownSymbol fn, SingI cs, SingI schema) => Iso' (FieldRepr '(fn, SchemaArray cs schema)) (Vector (JsonRepr schema))
objectRepr :: (KnownSymbol fn, SingI fields) => Iso' (FieldRepr '(fn, SchemaObject fields)) (Rec FieldRepr fields)
optionalRepr :: (KnownSymbol fn, SingI schema) => Iso' (FieldRepr '(fn, SchemaOptional schema)) (Maybe (JsonRepr schema))

Documentation

type family FIndex (r :: Symbol) (rs :: [(Symbol, Schema)]) :: Nat where ... Source #

A partial relation that gives the index of a value in a list.

Equations

FIndex r ('(r, s) ': rs) = Z
FIndex r (s ': rs) = S (FIndex r rs)

class i ~ FIndex fn rs => FElem (fn :: Symbol) (rs :: [(Symbol, Schema)]) (i :: Nat) where Source #

Minimal complete definition

flens, fget, fput

Associated Types

type ByField fn rs i :: Schema Source #

Methods

flens :: Flens fn f g rs i Source #

fget :: FGetter fn f rs i Source #

For Vinyl users who are not using the lens package, we provide a getter.

fput :: f '(fn, ByField fn rs i) -> Rec f rs -> Rec f rs Source #

For Vinyl users who are not using the lens package, we also provide a setter. In general, it will be unambiguous what field is being written to, and so we do not take a proxy argument here.

Instances

FElem fn ((,) fn r ': rs) Z Source #
Instance details Defined in Data.Schematic.Lens Associated Types type ByField fn ((fn, r) ': rs) Z :: Schema Source # Methods flens :: Functor g => (f (fn, ByField fn ((fn, r) ': rs) Z) -> g (f (fn, ByField fn ((fn, r) ': rs) Z))) -> Rec f ((fn, r) ': rs) -> g (Rec f ((fn, r) ': rs)) Source # fget :: FGetter fn f ((fn, r) ': rs) Z Source # fput :: f (fn, ByField fn ((fn, r) ': rs) Z) -> Rec f ((fn, r) ': rs) -> Rec f ((fn, r) ': rs) Source #
(FIndex r (s ': rs) ~ S i, FElem r rs i) => FElem r (s ': rs) (S i) Source #
Instance details Defined in Data.Schematic.Lens Associated Types type ByField r (s ': rs) (S i) :: Schema Source # Methods flens :: Functor g => (f (r, ByField r (s ': rs) (S i)) -> g (f (r, ByField r (s ': rs) (S i)))) -> Rec f (s ': rs) -> g (Rec f (s ': rs)) Source # fget :: FGetter r f (s ': rs) (S i) Source # fput :: f (r, ByField r (s ': rs) (S i)) -> Rec f (s ': rs) -> Rec f (s ': rs) Source #

type family FImage (rs :: [(Symbol, Schema)]) (ss :: [(Symbol, Schema)]) :: [Nat] where ... Source #

A partial relation that gives the indices of a sublist in a larger list.

Equations

FImage '[] ss = '[]
FImage ('(fn, s) ': rs) ss = FIndex fn ss ': FImage rs ss

class is ~ FImage rs ss => FSubset (rs :: [(Symbol, Schema)]) (ss :: [(Symbol, Schema)]) is where Source #

Minimal complete definition

fsubset

Methods

fsubset :: Functor g => (Rec f rs -> g (Rec f rs)) -> Rec f ss -> g (Rec f ss) Source #

This is a lens into a slice of the larger record. Morally, we have:

fsubset :: Lens' (Rec FieldRepr ss) (Rec FieldRepr rs)

fcast :: Rec f ss -> Rec f rs Source #

The getter of the fsubset lens is fcast, which takes a larger record to a smaller one by forgetting fields.

freplace :: Rec f rs -> Rec f ss -> Rec f ss Source #

The setter of the fsubset lens is freplace, which allows a slice of a record to be replaced with different values.

Instances

FSubset ([] :: [(Symbol, Schema)]) ss ([] :: [Nat]) Source #
Instance details Defined in Data.Schematic.Lens Methods fsubset :: Functor g => (Rec f [] -> g (Rec f [])) -> Rec f ss -> g (Rec f ss) Source # fcast :: Rec f ss -> Rec f [] Source # freplace :: Rec f [] -> Rec f ss -> Rec f ss Source #
(ByField fn ss i ~ s, FElem fn ss i, FSubset rs ss is) => FSubset ((,) fn s ': rs) ss (i ': is) Source #
Instance details Defined in Data.Schematic.Lens Methods fsubset :: Functor g => (Rec f ((fn, s) ': rs) -> g (Rec f ((fn, s) ': rs))) -> Rec f ss -> g (Rec f ss) Source # fcast :: Rec f ss -> Rec f ((fn, s) ': rs) Source # freplace :: Rec f ((fn, s) ': rs) -> Rec f ss -> Rec f ss Source #

obj :: Iso' (JsonRepr (SchemaObject fields)) (Rec FieldRepr fields) Source #

arr :: Iso' (JsonRepr (SchemaArray cs schema)) (Vector (JsonRepr schema)) Source #

uni :: Iso' (JsonRepr (SchemaUnion (h ': tl))) (Union JsonRepr (h ': tl)) Source #

txt :: Iso' (JsonRepr (SchemaText cs)) Text Source #

num :: Iso' (JsonRepr (SchemaNumber cs)) Scientific Source #

opt :: Iso' (JsonRepr (SchemaOptional schema)) (Maybe (JsonRepr schema)) Source #

bln :: Iso' (JsonRepr SchemaBoolean) Bool Source #

textRepr :: (KnownSymbol fn, SingI cs) => Iso' (FieldRepr '(fn, SchemaText cs)) Text Source #

numberRepr :: (KnownSymbol fn, SingI cs) => Iso' (FieldRepr '(fn, SchemaNumber cs)) Scientific Source #

boolRepr :: KnownSymbol fn => Iso' (FieldRepr '(fn, SchemaBoolean)) Bool Source #

arrayRepr :: (KnownSymbol fn, SingI cs, SingI schema) => Iso' (FieldRepr '(fn, SchemaArray cs schema)) (Vector (JsonRepr schema)) Source #

objectRepr :: (KnownSymbol fn, SingI fields) => Iso' (FieldRepr '(fn, SchemaObject fields)) (Rec FieldRepr fields) Source #

optionalRepr :: (KnownSymbol fn, SingI schema) => Iso' (FieldRepr '(fn, SchemaOptional schema)) (Maybe (JsonRepr schema)) Source #