Copyright	(c) Fumiaki Kinoshita 2018
License	BSD3
Maintainer	Fumiaki Kinoshita <[email protected]>
Safe Haskell	None
Language	Haskell2010

Data.Extensible.Field

Contents

Records and variants
Matching
Key / value
Orphan instances

Description

Flexible records and variants

Synopsis

newtype Field (h :: v -> Type) (kv :: Assoc k v) = Field {
- getField :: h (TargetOf kv)
}
(@=) :: forall {v1} {k1} (h :: v1 -> Type) (k2 :: k1) (v2 :: v1). Wrapper h => Proxy k2 -> Repr h v2 -> Field h (k2 ':> v2)
(<@=>) :: forall {v1} {k1} f (h :: v1 -> Type) (k2 :: k1) (v2 :: v1). (Functor f, Wrapper h) => Proxy k2 -> f (Repr h v2) -> Compose f (Field h :: Assoc k1 v1 -> Type) (k2 ':> v2)
(@:>) :: forall {k1} {v1} (k2 :: k1) h (v2 :: v1). Proxy k2 -> h v2 -> Field h (k2 ':> v2)
(@==) :: forall (k :: Symbol) v. Proxy k -> v -> Field Identity (k ':> v)
type FieldOptic (k1 :: k) = forall kind (f :: Type -> Type) (p :: Type -> Type -> Type) (t :: [Assoc k kind] -> (Assoc k kind -> Type) -> Type) (xs :: [Assoc k kind]) (h :: kind -> Type) (v :: kind). (Extensible f p t, ExtensibleConstr t xs (Field h :: Assoc k kind -> Type) (k1 ':> v), Lookup xs k1 v, Wrapper h) => Optic' p f (t xs (Field h :: Assoc k kind -> Type)) (Repr h v)
xlb :: forall {k1} (k2 :: k1). Proxy k2 -> FieldOptic k2
liftField :: forall {v} {k} g (kv :: Assoc k v) h. (g (TargetOf kv) -> h (TargetOf kv)) -> Field g kv -> Field h kv
liftField2 :: forall {v} {k} f (kv :: Assoc k v) g h. (f (TargetOf kv) -> g (TargetOf kv) -> h (TargetOf kv)) -> Field f kv -> Field g kv -> Field h kv
type RecordOf (h :: v -> Type) (xs :: [Assoc k v]) = xs :& (Field h :: Assoc k v -> Type)
type Record (xs :: [Assoc k Type]) = RecordOf Identity xs
emptyRecord :: Record ('[] :: [Assoc k Type])
type VariantOf (h :: v -> Type) (xs :: [Assoc k v]) = xs :/ (Field h :: Assoc k v -> Type)
type Variant (xs :: [Assoc k Type]) = VariantOf Identity xs
matchWithField :: forall {v} {k} f g r (xs :: [Assoc k v]). (forall (x :: v). f x -> g x -> r) -> RecordOf f xs -> VariantOf g xs -> r
matchField :: forall {v} {k} (h :: v -> Type) r (xs :: [Assoc k v]). RecordOf (Match h r) xs -> VariantOf h xs -> r
type family KeyOf (kv :: Assoc k v) :: k where ...
proxyKeyOf :: forall {k} {v} proxy (kv :: Assoc k v). proxy kv -> Proxy (KeyOf kv)
stringKeyOf :: forall {v} a (kv :: Assoc Symbol v) proxy. (IsString a, KnownSymbol (KeyOf kv)) => proxy kv -> a
type family TargetOf (kv :: Assoc k v) :: v where ...
proxyTargetOf :: forall {k1} {k2} proxy (kv :: Assoc k1 k2). proxy kv -> Proxy (TargetOf kv)
class pk (KeyOf kv) => KeyIs (pk :: k -> Constraint) (kv :: Assoc k v)
class pv (TargetOf kv) => TargetIs (pv :: k -> Constraint) (kv :: Assoc k1 k)
class (pk (KeyOf kv), pv (TargetOf kv)) => KeyTargetAre (pk :: k -> Constraint) (pv :: k1 -> Constraint) (kv :: Assoc k k1)

Documentation

newtype Field (h :: v -> Type) (kv :: Assoc k v) Source #

A Field h (k ':> v) is h v annotated with the field name k.

Field :: (v -> Type) -> Assoc k v -> Type

Constructors

Field
Fields getField :: h (TargetOf kv)

Instances

Instances details

(Lookup xs k2 v2, Wrapper h, Repr h v2 ~ a) => HasField (k2 :: k1) (RecordOf h xs) a Source #

Instance details

Defined in Data.Extensible.Dictionary

Methods

getField :: RecordOf h xs -> a #

(Bits r, KnownNat (BitWidth (h (TargetOf x))), FromBits r (h (TargetOf x))) => FromBits r (Field h x) Source #

Instance details

Defined in Data.Extensible.Bits

Associated Types

type BitWidth (Field h x)
Instance details Defined in Data.Extensible.Bits type BitWidth (Field h x) = BitWidth (h (TargetOf x))

Methods

fromBits :: r -> Field h x Source #

toBits :: Field h x -> r Source #

Lift (h (TargetOf kv)) => Lift (Field h kv :: Type) Source #

Instance details

Defined in Data.Extensible.Field

Methods

lift :: Quote m => Field h kv -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => Field h kv -> Code m (Field h kv) #

Unbox (h (TargetOf x)) => Vector Vector (Field h x) Source #

Instance details

Defined in Data.Extensible.Field

Methods

basicUnsafeFreeze :: Mutable Vector s (Field h x) -> ST s (Vector (Field h x))

basicUnsafeThaw :: Vector (Field h x) -> ST s (Mutable Vector s (Field h x))

basicLength :: Vector (Field h x) -> Int

basicUnsafeSlice :: Int -> Int -> Vector (Field h x) -> Vector (Field h x)

basicUnsafeIndexM :: Vector (Field h x) -> Int -> Box (Field h x)

basicUnsafeCopy :: Mutable Vector s (Field h x) -> Vector (Field h x) -> ST s ()

elemseq :: Vector (Field h x) -> Field h x -> b -> b

Unbox (h (TargetOf x)) => MVector MVector (Field h x) Source #

Instance details

Defined in Data.Extensible.Field

Methods

basicLength :: MVector s (Field h x) -> Int

basicUnsafeSlice :: Int -> Int -> MVector s (Field h x) -> MVector s (Field h x)

basicOverlaps :: MVector s (Field h x) -> MVector s (Field h x) -> Bool

basicUnsafeNew :: Int -> ST s (MVector s (Field h x))

basicInitialize :: MVector s (Field h x) -> ST s ()

basicUnsafeReplicate :: Int -> Field h x -> ST s (MVector s (Field h x))

basicUnsafeRead :: MVector s (Field h x) -> Int -> ST s (Field h x)

basicUnsafeWrite :: MVector s (Field h x) -> Int -> Field h x -> ST s ()

basicClear :: MVector s (Field h x) -> ST s ()

basicSet :: MVector s (Field h x) -> Field h x -> ST s ()

basicUnsafeCopy :: MVector s (Field h x) -> MVector s (Field h x) -> ST s ()

basicUnsafeMove :: MVector s (Field h x) -> MVector s (Field h x) -> ST s ()

basicUnsafeGrow :: MVector s (Field h x) -> Int -> ST s (MVector s (Field h x))

Wrapper h => Wrapper (Field h :: Assoc k v -> Type) Source #

Instance details

Defined in Data.Extensible.Field

Methods

_Wrapper :: forall f p (v0 :: Assoc k v). (Functor f, Profunctor p) => Optic' p f (Field h v0) (Repr (Field h :: Assoc k v -> Type) v0) Source #

wrap :: forall (v0 :: Assoc k v). Repr (Field h :: Assoc k v -> Type) v0 -> Field h v0 Source #

unwrap :: forall (v0 :: Assoc k v). Field h v0 -> Repr (Field h :: Assoc k v -> Type) v0 Source #

Forall (KeyTargetAre KnownSymbol (Instance1 FromJSON h)) xs => FromJSON (xs :& (Field h :: Assoc Symbol v -> Type)) Source #

parseJSON Null is called for missing fields.

Instance details

Defined in Data.Extensible.Dictionary

Methods

parseJSON :: Value -> Parser (xs :& (Field h :: Assoc Symbol v -> Type)) #

parseJSONList :: Value -> Parser [xs :& (Field h :: Assoc Symbol v -> Type)] #

omittedField :: Maybe (xs :& (Field h :: Assoc Symbol v -> Type)) #

Forall (KeyTargetAre KnownSymbol (Instance1 FromJSON h)) xs => FromJSON (xs :& Nullable (Field h :: Assoc Symbol v -> Type)) Source #

Instance details

Defined in Data.Extensible.Dictionary

Methods

parseJSON :: Value -> Parser (xs :& Nullable (Field h :: Assoc Symbol v -> Type)) #

parseJSONList :: Value -> Parser [xs :& Nullable (Field h :: Assoc Symbol v -> Type)] #

omittedField :: Maybe (xs :& Nullable (Field h :: Assoc Symbol v -> Type)) #

Forall (KeyTargetAre KnownSymbol (Instance1 ToJSON h)) xs => ToJSON (xs :& (Field h :: Assoc Symbol v -> Type)) Source #

Instance details

Defined in Data.Extensible.Dictionary

Methods

toJSON :: (xs :& (Field h :: Assoc Symbol v -> Type)) -> Value #

toEncoding :: (xs :& (Field h :: Assoc Symbol v -> Type)) -> Encoding #

toJSONList :: [xs :& (Field h :: Assoc Symbol v -> Type)] -> Value #

toEncodingList :: [xs :& (Field h :: Assoc Symbol v -> Type)] -> Encoding #

omitField :: (xs :& (Field h :: Assoc Symbol v -> Type)) -> Bool #

Forall (KeyTargetAre KnownSymbol (Instance1 ToJSON h)) xs => ToJSON (xs :& Nullable (Field h :: Assoc Symbol v -> Type)) Source #

Instance details

Defined in Data.Extensible.Dictionary

Methods

toJSON :: (xs :& Nullable (Field h :: Assoc Symbol v -> Type)) -> Value #

toEncoding :: (xs :& Nullable (Field h :: Assoc Symbol v -> Type)) -> Encoding #

toJSONList :: [xs :& Nullable (Field h :: Assoc Symbol v -> Type)] -> Value #

toEncodingList :: [xs :& Nullable (Field h :: Assoc Symbol v -> Type)] -> Encoding #

omitField :: (xs :& Nullable (Field h :: Assoc Symbol v -> Type)) -> Bool #

Forall (KeyTargetAre KnownSymbol (Instance1 FromField h)) xs => FromNamedRecord (xs :& (Field h :: Assoc Symbol v -> Type)) Source #

Instance details

Defined in Data.Extensible.Dictionary

Methods

parseNamedRecord :: NamedRecord -> Parser (xs :& (Field h :: Assoc Symbol v -> Type)) #

Forall (KeyTargetAre KnownSymbol (Instance1 ToField h)) xs => ToNamedRecord (xs :& (Field h :: Assoc Symbol v -> Type)) Source #

Instance details

Defined in Data.Extensible.Dictionary

Methods

toNamedRecord :: (xs :& (Field h :: Assoc Symbol v -> Type)) -> NamedRecord #

Arbitrary (h (TargetOf kv)) => Arbitrary (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

arbitrary :: Gen (Field h kv) #

shrink :: Field h kv -> [Field h kv] #

FromJSON (h (TargetOf kv)) => FromJSON (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

parseJSON :: Value -> Parser (Field h kv) #

parseJSONList :: Value -> Parser [Field h kv] #

omittedField :: Maybe (Field h kv) #

ToJSON (h (TargetOf kv)) => ToJSON (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

toJSON :: Field h kv -> Value #

toEncoding :: Field h kv -> Encoding #

toJSONList :: [Field h kv] -> Value #

toEncodingList :: [Field h kv] -> Encoding #

omitField :: Field h kv -> Bool #

Storable (h (TargetOf kv)) => Storable (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

sizeOf :: Field h kv -> Int #

alignment :: Field h kv -> Int #

peekElemOff :: Ptr (Field h kv) -> Int -> IO (Field h kv) #

pokeElemOff :: Ptr (Field h kv) -> Int -> Field h kv -> IO () #

peekByteOff :: Ptr b -> Int -> IO (Field h kv) #

pokeByteOff :: Ptr b -> Int -> Field h kv -> IO () #

peek :: Ptr (Field h kv) -> IO (Field h kv) #

poke :: Ptr (Field h kv) -> Field h kv -> IO () #

Monoid (h (TargetOf kv)) => Monoid (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

mempty :: Field h kv #

mappend :: Field h kv -> Field h kv -> Field h kv #

mconcat :: [Field h kv] -> Field h kv #

Semigroup (h (TargetOf kv)) => Semigroup (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

(<>) :: Field h kv -> Field h kv -> Field h kv #

sconcat :: NonEmpty (Field h kv) -> Field h kv #

stimes :: Integral b => b -> Field h kv -> Field h kv #

Bounded (h (TargetOf kv)) => Bounded (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

minBound :: Field h kv #

maxBound :: Field h kv #

Enum (h (TargetOf kv)) => Enum (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

succ :: Field h kv -> Field h kv #

pred :: Field h kv -> Field h kv #

toEnum :: Int -> Field h kv #

fromEnum :: Field h kv -> Int #

enumFrom :: Field h kv -> [Field h kv] #

enumFromThen :: Field h kv -> Field h kv -> [Field h kv] #

enumFromTo :: Field h kv -> Field h kv -> [Field h kv] #

enumFromThenTo :: Field h kv -> Field h kv -> Field h kv -> [Field h kv] #

Floating (h (TargetOf kv)) => Floating (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

pi :: Field h kv #

exp :: Field h kv -> Field h kv #

log :: Field h kv -> Field h kv #

sqrt :: Field h kv -> Field h kv #

(**) :: Field h kv -> Field h kv -> Field h kv #

logBase :: Field h kv -> Field h kv -> Field h kv #

sin :: Field h kv -> Field h kv #

cos :: Field h kv -> Field h kv #

tan :: Field h kv -> Field h kv #

asin :: Field h kv -> Field h kv #

acos :: Field h kv -> Field h kv #

atan :: Field h kv -> Field h kv #

sinh :: Field h kv -> Field h kv #

cosh :: Field h kv -> Field h kv #

tanh :: Field h kv -> Field h kv #

asinh :: Field h kv -> Field h kv #

acosh :: Field h kv -> Field h kv #

atanh :: Field h kv -> Field h kv #

log1p :: Field h kv -> Field h kv #

expm1 :: Field h kv -> Field h kv #

log1pexp :: Field h kv -> Field h kv #

log1mexp :: Field h kv -> Field h kv #

RealFloat (h (TargetOf kv)) => RealFloat (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

floatRadix :: Field h kv -> Integer #

floatDigits :: Field h kv -> Int #

floatRange :: Field h kv -> (Int, Int) #

decodeFloat :: Field h kv -> (Integer, Int) #

encodeFloat :: Integer -> Int -> Field h kv #

exponent :: Field h kv -> Int #

significand :: Field h kv -> Field h kv #

scaleFloat :: Int -> Field h kv -> Field h kv #

isNaN :: Field h kv -> Bool #

isInfinite :: Field h kv -> Bool #

isDenormalized :: Field h kv -> Bool #

isNegativeZero :: Field h kv -> Bool #

isIEEE :: Field h kv -> Bool #

atan2 :: Field h kv -> Field h kv -> Field h kv #

Generic (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Associated Types

type Rep (Field h kv)
Instance details Defined in Data.Extensible.Field type Rep (Field h kv) = D1 ('MetaData "Field" "Data.Extensible.Field" "extensible-0.9.2-4T9Z6Fi5USt46xSSDAXrdd" 'True) (C1 ('MetaCons "Field" 'PrefixI 'True) (S1 ('MetaSel ('Just "getField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (h (TargetOf kv)))))

Methods

from :: Field h kv -> Rep (Field h kv) x #

to :: Rep (Field h kv) x -> Field h kv #

Num (h (TargetOf kv)) => Num (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

(+) :: Field h kv -> Field h kv -> Field h kv #

(-) :: Field h kv -> Field h kv -> Field h kv #

(*) :: Field h kv -> Field h kv -> Field h kv #

negate :: Field h kv -> Field h kv #

abs :: Field h kv -> Field h kv #

signum :: Field h kv -> Field h kv #

fromInteger :: Integer -> Field h kv #

Fractional (h (TargetOf kv)) => Fractional (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

(/) :: Field h kv -> Field h kv -> Field h kv #

recip :: Field h kv -> Field h kv #

fromRational :: Rational -> Field h kv #

Integral (h (TargetOf kv)) => Integral (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

quot :: Field h kv -> Field h kv -> Field h kv #

rem :: Field h kv -> Field h kv -> Field h kv #

div :: Field h kv -> Field h kv -> Field h kv #

mod :: Field h kv -> Field h kv -> Field h kv #

quotRem :: Field h kv -> Field h kv -> (Field h kv, Field h kv) #

divMod :: Field h kv -> Field h kv -> (Field h kv, Field h kv) #

toInteger :: Field h kv -> Integer #

Real (h (TargetOf kv)) => Real (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

toRational :: Field h kv -> Rational #

RealFrac (h (TargetOf kv)) => RealFrac (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

properFraction :: Integral b => Field h kv -> (b, Field h kv) #

truncate :: Integral b => Field h kv -> b #

round :: Integral b => Field h kv -> b #

ceiling :: Integral b => Field h kv -> b #

floor :: Integral b => Field h kv -> b #

(KnownSymbol k, Wrapper h, Show (Repr h v2)) => Show (Field h (k ':> v2)) Source #

Shows in field @= value style instead of the derived one.

Instance details

Defined in Data.Extensible.Field

Methods

showsPrec :: Int -> Field h (k ':> v2) -> ShowS #

show :: Field h (k ':> v2) -> String #

showList :: [Field h (k ':> v2)] -> ShowS #

Forall (KeyIs KnownSymbol :: Assoc Symbol v -> Constraint) xs => DefaultOrdered (RecordOf h xs) Source #

Instance details

Defined in Data.Extensible.Dictionary

Methods

headerOrder :: RecordOf h xs -> Header #

FromField (h (TargetOf kv)) => FromField (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

parseField :: Field -> Parser (Field h kv) #

ToField (h (TargetOf kv)) => ToField (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

toField :: Field h kv -> Field #

NFData (h (TargetOf kv)) => NFData (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

rnf :: Field h kv -> () #

Eq (h (TargetOf kv)) => Eq (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

(==) :: Field h kv -> Field h kv -> Bool #

(/=) :: Field h kv -> Field h kv -> Bool #

Ord (h (TargetOf kv)) => Ord (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

compare :: Field h kv -> Field h kv -> Ordering #

(<) :: Field h kv -> Field h kv -> Bool #

(<=) :: Field h kv -> Field h kv -> Bool #

(>) :: Field h kv -> Field h kv -> Bool #

(>=) :: Field h kv -> Field h kv -> Bool #

max :: Field h kv -> Field h kv -> Field h kv #

min :: Field h kv -> Field h kv -> Field h kv #

Hashable (h (TargetOf kv)) => Hashable (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Methods

hashWithSalt :: Int -> Field h kv -> Int #

hash :: Field h kv -> Int #

Incremental (h (TargetOf kv)) => Incremental (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

Associated Types

type Delta (Field h kv)
Instance details Defined in Data.Extensible.Field type Delta (Field h kv) = Delta (h (TargetOf kv))

Methods

patch :: Field h kv -> Delta (Field h kv) -> Field h kv #

diff :: Field h kv -> Field h kv -> Maybe (Delta (Field h kv)) #

(KnownSymbol k, Pretty (h v2)) => Pretty (Field h (k ':> v2)) Source #

Instance details

Defined in Data.Extensible.Field

Methods

pretty :: Field h (k ':> v2) -> Doc ann #

prettyList :: [Field h (k ':> v2)] -> Doc ann #

Unbox (h (TargetOf x)) => Unbox (Field h x) Source #

Instance details

Defined in Data.Extensible.Field

newtype MVector s (Field h x) Source #

Instance details

Defined in Data.Extensible.Field

newtype MVector s (Field h x) = MV_Field (MVector s (h (TargetOf x)))

type Repr (Field h :: Assoc k v -> Type) (kv :: Assoc k v) Source #

Instance details

Defined in Data.Extensible.Field

type Repr (Field h :: Assoc k v -> Type) (kv :: Assoc k v) = Repr h (TargetOf kv)

type Rep (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

type Rep (Field h kv) = D1 ('MetaData "Field" "Data.Extensible.Field" "extensible-0.9.2-4T9Z6Fi5USt46xSSDAXrdd" 'True) (C1 ('MetaCons "Field" 'PrefixI 'True) (S1 ('MetaSel ('Just "getField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (h (TargetOf kv)))))

type BitWidth (Field h x) Source #

Instance details

Defined in Data.Extensible.Bits

type BitWidth (Field h x) = BitWidth (h (TargetOf x))

type Delta (Field h kv) Source #

Instance details

Defined in Data.Extensible.Field

type Delta (Field h kv) = Delta (h (TargetOf kv))

newtype Vector (Field h x) Source #

Instance details

Defined in Data.Extensible.Field

newtype Vector (Field h x) = V_Field (Vector (h (TargetOf x)))

(@=) :: forall {v1} {k1} (h :: v1 -> Type) (k2 :: k1) (v2 :: v1). Wrapper h => Proxy k2 -> Repr h v2 -> Field h (k2 ':> v2) infix 1 Source #

Annotate a value by the field name.

foo :: Record '["num" >: Int, "str" >: String]
foo = #num @= 42
  <: #str @= "foo"
  <: nil

(<@=>) :: forall {v1} {k1} f (h :: v1 -> Type) (k2 :: k1) (v2 :: v1). (Functor f, Wrapper h) => Proxy k2 -> f (Repr h v2) -> Compose f (Field h :: Assoc k1 v1 -> Type) (k2 ':> v2) infix 1 Source #

Lifted (@=)

foo :: IO (Record '["num" >: Int, "str" >: String])
foo = hsequence
  $ #num <@=> readLn
  <: #str <@=> getLine
  <: nil

(@:>) :: forall {k1} {v1} (k2 :: k1) h (v2 :: v1). Proxy k2 -> h v2 -> Field h (k2 ':> v2) infix 1 Source #

Annotate a value by the field name without Wrapper.

(@==) :: forall (k :: Symbol) v. Proxy k -> v -> Field Identity (k ':> v) infix 1 Source #

Kind-monomorphic, unwrapped version of @=

type FieldOptic (k1 :: k) = forall kind (f :: Type -> Type) (p :: Type -> Type -> Type) (t :: [Assoc k kind] -> (Assoc k kind -> Type) -> Type) (xs :: [Assoc k kind]) (h :: kind -> Type) (v :: kind). (Extensible f p t, ExtensibleConstr t xs (Field h :: Assoc k kind -> Type) (k1 ':> v), Lookup xs k1 v, Wrapper h) => Optic' p f (t xs (Field h :: Assoc k kind -> Type)) (Repr h v) Source #

FieldOptic s is a type of optics that points a field/constructor named s.

The yielding fields can be Lenses for Records and Prisms for Variants.

FieldOptic "foo" = Lookup xs "foo" a => Lens' (Record xs) a
FieldOptic "foo" = Lookup xs "foo" a => Prism' (Variant xs) a

FieldOptics can be generated using mkField defined in the Data.Extensible.TH module.

xlb :: forall {k1} (k2 :: k1). Proxy k2 -> FieldOptic k2 Source #

Specialised version of itemAssoc. Stands for "eXtensible LaBel"

liftField :: forall {v} {k} g (kv :: Assoc k v) h. (g (TargetOf kv) -> h (TargetOf kv)) -> Field g kv -> Field h kv Source #

Lift a function for the content.

liftField2 :: forall {v} {k} f (kv :: Assoc k v) g h. (f (TargetOf kv) -> g (TargetOf kv) -> h (TargetOf kv)) -> Field f kv -> Field g kv -> Field h kv Source #

Lift a function for the content.

Records and variants

type RecordOf (h :: v -> Type) (xs :: [Assoc k v]) = xs :& (Field h :: Assoc k v -> Type) Source #

The type of records which contain several fields.

RecordOf :: (v -> Type) -> [Assoc k v] -> Type

type Record (xs :: [Assoc k Type]) = RecordOf Identity xs Source #

Simple record

emptyRecord :: Record ('[] :: [Assoc k Type]) Source #

An empty Record.

type VariantOf (h :: v -> Type) (xs :: [Assoc k v]) = xs :/ (Field h :: Assoc k v -> Type) Source #

The dual of RecordOf

VariantOf :: (v -> Type) -> [Assoc k v] -> Type

type Variant (xs :: [Assoc k Type]) = VariantOf Identity xs Source #

Simple variant

Matching

matchWithField :: forall {v} {k} f g r (xs :: [Assoc k v]). (forall (x :: v). f x -> g x -> r) -> RecordOf f xs -> VariantOf g xs -> r Source #

Select a corresponding field of a variant.

matchField :: forall {v} {k} (h :: v -> Type) r (xs :: [Assoc k v]). RecordOf (Match h r) xs -> VariantOf h xs -> r Source #

Pattern matching on a Variant

Key / value

type family KeyOf (kv :: Assoc k v) :: k where ... #

Take the type of the key

Equations

KeyOf (k2 ':> v2 :: Assoc k1 v1) = k2

proxyKeyOf :: forall {k} {v} proxy (kv :: Assoc k v). proxy kv -> Proxy (KeyOf kv) #

Proxy-level KeyOf. This is useful when using symbolVal.

stringKeyOf :: forall {v} a (kv :: Assoc Symbol v) proxy. (IsString a, KnownSymbol (KeyOf kv)) => proxy kv -> a #

Get a string from a proxy of Assoc Symbol v.

type family TargetOf (kv :: Assoc k v) :: v where ... #

Take the type of the value

Equations

TargetOf (k2 ':> v2 :: Assoc k1 v1) = v2

proxyTargetOf :: forall {k1} {k2} proxy (kv :: Assoc k1 k2). proxy kv -> Proxy (TargetOf kv) #

Proxy-level TargetOf.

class pk (KeyOf kv) => KeyIs (pk :: k -> Constraint) (kv :: Assoc k v) #

Constraint applied to KeyOf

Instances

Instances details

pk k2 => KeyIs (pk :: k1 -> Constraint) (k2 ':> v2 :: Assoc k1 v1)
Instance details Defined in Type.Membership

class pv (TargetOf kv) => TargetIs (pv :: k -> Constraint) (kv :: Assoc k1 k) #

Constraint applied to TargetOf

Instances

Instances details

pv v2 => TargetIs (pv :: v1 -> Constraint) (k2 ':> v2 :: Assoc k1 v1)
Instance details Defined in Type.Membership

class (pk (KeyOf kv), pv (TargetOf kv)) => KeyTargetAre (pk :: k -> Constraint) (pv :: k1 -> Constraint) (kv :: Assoc k k1) #

Combined constraint for Assoc

Instances

Instances details

(pk k2, pv v2) => KeyTargetAre (pk :: k1 -> Constraint) (pv :: v1 -> Constraint) (k2 ':> v2 :: Assoc k1 v1)
Instance details Defined in Type.Membership

Orphan instances

k ~ l => IsLabel k (Proxy l) Source #
Instance details Methods fromLabel :: Proxy l #