Safe Haskell	None
Language	Haskell2010

Lorentz.UStore.Traversal

Description

UStore templates generic traversals.

Normally you work with functionality of this module as follows: 1. Pick the function fitting most for your traversal, one of traverseUStore, foldUStore e.t.c. 2. Create a custom datatype value of which will be put to that function. 3. Implement a respective UStoreTemplateTraversable instance for this datatype.

Synopsis

class (Applicative (UStoreTraversalArgumentWrapper way), Applicative (UStoreTraversalMonad way)) => UStoreTraversalWay (way :: Type) where
- type UStoreTraversalArgumentWrapper way :: Type -> Type
- type UStoreTraversalMonad way :: Type -> Type
class UStoreTraversalWay way => UStoreTraversalFieldHandler (way :: Type) (marker :: UStoreMarkerType) (v :: Type) where
- ustoreTraversalFieldHandler :: KnownUStoreMarker marker => way -> Label name -> UStoreTraversalArgumentWrapper way v -> UStoreTraversalMonad way v
class UStoreTraversalWay way => UStoreTraversalSubmapHandler (way :: Type) (k :: Type) (v :: Type) where
- ustoreTraversalSubmapHandler :: way -> Label name -> UStoreTraversalArgumentWrapper way (Map k v) -> UStoreTraversalMonad way (Map k v)
type UStoreTraversable way a = (Generic a, GUStoreTraversable way (Rep a), UStoreTraversalWay way)
traverseUStore :: forall way template. UStoreTraversable way template => way -> UStoreTraversalArgumentWrapper way template -> UStoreTraversalMonad way template
modifyUStore :: (UStoreTraversable way template, UStoreTraversalArgumentWrapper way ~ Identity, UStoreTraversalMonad way ~ Identity) => way -> template -> template
foldUStore :: (UStoreTraversable way template, UStoreTraversalArgumentWrapper way ~ Identity, UStoreTraversalMonad way ~ Const res) => way -> template -> res
genUStore :: (UStoreTraversable way template, UStoreTraversalArgumentWrapper way ~ Const ()) => way -> UStoreTraversalMonad way template

Documentation

class (Applicative (UStoreTraversalArgumentWrapper way), Applicative (UStoreTraversalMonad way)) => UStoreTraversalWay (way :: Type) Source #

Defines general parameters of UStore template traversal. You need a separate way datatype with an instance of this typeclass for each type of traversal.

Associated Types

type UStoreTraversalArgumentWrapper way :: Type -> Type Source #

Wrapper which will accompany the existing value of traversed template, aka argument. This is usually Identity or Const a.

type UStoreTraversalMonad way :: Type -> Type Source #

Additional constraints on monadic action used in traversal. Common ones include Identity, Const, (,) a

Instances

Instances details

UStoreTraversalWay DocumentTW Source #
Instance details Defined in Lorentz.UStore.Doc Associated Types type UStoreTraversalArgumentWrapper DocumentTW :: Type -> Type Source # type UStoreTraversalMonad DocumentTW :: Type -> Type Source #
UStoreTraversalWay FillUStoreTW Source #
Instance details Defined in Lorentz.UStore.Haskell Associated Types type UStoreTraversalArgumentWrapper FillUStoreTW :: Type -> Type Source # type UStoreTraversalMonad FillUStoreTW :: Type -> Type Source #
UStoreTraversalWay DecomposeUStoreTW Source #
Instance details Defined in Lorentz.UStore.Haskell Associated Types type UStoreTraversalArgumentWrapper DecomposeUStoreTW :: Type -> Type Source # type UStoreTraversalMonad DecomposeUStoreTW :: Type -> Type Source #
UStoreTraversalWay MkUStoreTW Source #
Instance details Defined in Lorentz.UStore.Haskell Associated Types type UStoreTraversalArgumentWrapper MkUStoreTW :: Type -> Type Source # type UStoreTraversalMonad MkUStoreTW :: Type -> Type Source #

class UStoreTraversalWay way => UStoreTraversalFieldHandler (way :: Type) (marker :: UStoreMarkerType) (v :: Type) where Source #

Declares a handler for UStore fields when given traversal way is applied.

Methods

ustoreTraversalFieldHandler :: KnownUStoreMarker marker => way -> Label name -> UStoreTraversalArgumentWrapper way v -> UStoreTraversalMonad way v Source #

How to process each of UStore fields.

Instances

Instances details

(UStoreMarkerHasDoc marker, TypeHasDoc v) => UStoreTraversalFieldHandler DocumentTW marker v Source #
Instance details Defined in Lorentz.UStore.Doc Methods ustoreTraversalFieldHandler :: forall (name :: Symbol). KnownUStoreMarker marker => DocumentTW -> Label name -> UStoreTraversalArgumentWrapper DocumentTW v -> UStoreTraversalMonad DocumentTW v Source #
NiceConstant v => UStoreTraversalFieldHandler FillUStoreTW marker v Source #
Instance details Defined in Lorentz.UStore.Haskell Methods ustoreTraversalFieldHandler :: forall (name :: Symbol). KnownUStoreMarker marker => FillUStoreTW -> Label name -> UStoreTraversalArgumentWrapper FillUStoreTW v -> UStoreTraversalMonad FillUStoreTW v Source #
NiceUnpackedValue val => UStoreTraversalFieldHandler DecomposeUStoreTW marker val Source #
Instance details Defined in Lorentz.UStore.Haskell Methods ustoreTraversalFieldHandler :: forall (name :: Symbol). KnownUStoreMarker marker => DecomposeUStoreTW -> Label name -> UStoreTraversalArgumentWrapper DecomposeUStoreTW val -> UStoreTraversalMonad DecomposeUStoreTW val Source #
NicePackedValue val => UStoreTraversalFieldHandler MkUStoreTW marker val Source #
Instance details Defined in Lorentz.UStore.Haskell Methods ustoreTraversalFieldHandler :: forall (name :: Symbol). KnownUStoreMarker marker => MkUStoreTW -> Label name -> UStoreTraversalArgumentWrapper MkUStoreTW val -> UStoreTraversalMonad MkUStoreTW val Source #

class UStoreTraversalWay way => UStoreTraversalSubmapHandler (way :: Type) (k :: Type) (v :: Type) where Source #

Declares a handler for UStore submaps when given traversal way is applied.

Methods

ustoreTraversalSubmapHandler :: way -> Label name -> UStoreTraversalArgumentWrapper way (Map k v) -> UStoreTraversalMonad way (Map k v) Source #

How to process each of UStore submaps.

Instances

Instances details

(TypeHasDoc k, TypeHasDoc v) => UStoreTraversalSubmapHandler DocumentTW k v Source #
Instance details Defined in Lorentz.UStore.Doc Methods ustoreTraversalSubmapHandler :: forall (name :: Symbol). DocumentTW -> Label name -> UStoreTraversalArgumentWrapper DocumentTW (Map k v) -> UStoreTraversalMonad DocumentTW (Map k v) Source #
(NiceConstant k, NiceConstant v) => UStoreTraversalSubmapHandler FillUStoreTW k v Source #
Instance details Defined in Lorentz.UStore.Haskell Methods ustoreTraversalSubmapHandler :: forall (name :: Symbol). FillUStoreTW -> Label name -> UStoreTraversalArgumentWrapper FillUStoreTW (Map k v) -> UStoreTraversalMonad FillUStoreTW (Map k v) Source #
(Ord k, NiceUnpackedValue k, NiceUnpackedValue v) => UStoreTraversalSubmapHandler DecomposeUStoreTW k v Source #
Instance details Defined in Lorentz.UStore.Haskell Methods ustoreTraversalSubmapHandler :: forall (name :: Symbol). DecomposeUStoreTW -> Label name -> UStoreTraversalArgumentWrapper DecomposeUStoreTW (Map k v) -> UStoreTraversalMonad DecomposeUStoreTW (Map k v) Source #
(NicePackedValue k, NicePackedValue v) => UStoreTraversalSubmapHandler MkUStoreTW k v Source #
Instance details Defined in Lorentz.UStore.Haskell Methods ustoreTraversalSubmapHandler :: forall (name :: Symbol). MkUStoreTW -> Label name -> UStoreTraversalArgumentWrapper MkUStoreTW (Map k v) -> UStoreTraversalMonad MkUStoreTW (Map k v) Source #

type UStoreTraversable way a = (Generic a, GUStoreTraversable way (Rep a), UStoreTraversalWay way) Source #

Constraint for UStore traversal.

traverseUStore :: forall way template. UStoreTraversable way template => way -> UStoreTraversalArgumentWrapper way template -> UStoreTraversalMonad way template Source #

Perform UStore traversal. The most general way to perform a traversal.

modifyUStore :: (UStoreTraversable way template, UStoreTraversalArgumentWrapper way ~ Identity, UStoreTraversalMonad way ~ Identity) => way -> template -> template Source #

Modify each UStore entry.

foldUStore :: (UStoreTraversable way template, UStoreTraversalArgumentWrapper way ~ Identity, UStoreTraversalMonad way ~ Const res) => way -> template -> res Source #

Collect information about UStore entries into monoid.

genUStore :: (UStoreTraversable way template, UStoreTraversalArgumentWrapper way ~ Const ()) => way -> UStoreTraversalMonad way template Source #

Fill UStore template with entries.