Safe Haskell	Safe-Inferred
Language	GHC2021

Charon.Runner.Env

Description

Provides concrete Env type for running Charon.

Synopsis

data Env m = MkEnv {
- trashHome :: PathI TrashHome
- backend :: Backend
- logEnv :: LogEnv m
}
data LogEnv m = MkLogEnv {
- logFile :: !(Maybe (LogFile m))
- logNamespace :: Namespace
}
data LogFile m = MkLogFile {
- handle :: Handle
- logLevel :: LogLevel
}

Documentation

data Env m Source #

Concrete environment type that can be used for running Charon functions.

Constructors

MkEnv
Fields trashHome :: PathI TrashHome Trash home. backend :: Backend Backend. logEnv :: LogEnv m The logging environment.

Instances

Instances details

(k1 ~ A_Lens, a ~ Backend, b ~ Backend) => LabelOptic "backend" k1 (Env m) (Env m) a b Source #
Instance details Defined in Charon.Runner.Env Methods labelOptic :: Optic k1 NoIx (Env m) (Env m) a b Source #
(k1 ~ A_Lens, a ~ LogEnv m1, b ~ LogEnv m2) => LabelOptic "logEnv" k1 (Env m1) (Env m2) a b Source #
Instance details Defined in Charon.Runner.Env Methods labelOptic :: Optic k1 NoIx (Env m1) (Env m2) a b Source #
(k1 ~ A_Lens, a ~ PathI 'TrashHome, b ~ PathI 'TrashHome) => LabelOptic "trashHome" k1 (Env m) (Env m) a b Source #
Instance details Defined in Charon.Runner.Env Methods labelOptic :: Optic k1 NoIx (Env m) (Env m) a b Source #
Show (Env m) Source #
Instance details Defined in Charon.Runner.Env Methods showsPrec :: Int -> Env m -> ShowS # show :: Env m -> String # showList :: [Env m] -> ShowS #
HasBackend (Env m) Source #
Instance details Defined in Charon.Runner.Env Methods getBackend :: Env m -> Backend Source #
HasTrashHome (Env m) Source #
Instance details Defined in Charon.Runner.Env Methods getTrashHome :: Env m -> PathI 'TrashHome Source #
(MonadHandleWriter m, MonadTime m) => MonadLoggerNS (CharonT (Env m) m) Source #
Instance details Defined in Charon.Runner.CharonT Methods getNamespace :: CharonT (Env m) m Namespace Source # localNamespace :: HasCallStack => (Namespace -> Namespace) -> CharonT (Env m) m a -> CharonT (Env m) m a Source #
(MonadHandleWriter m, MonadTime m) => MonadLogger (CharonT (Env m) m) Source #
Instance details Defined in Charon.Runner.CharonT Methods monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> CharonT (Env m) m () Source #

data LogEnv m Source #

Holds logging env data.

Constructors

MkLogEnv
Fields logFile :: !(Maybe (LogFile m)) Data for file logging. logNamespace :: Namespace The current logging namespace.

Instances

Instances details

(k1 ~ A_Lens, a ~ Maybe (LogFile m1), b ~ Maybe (LogFile m2)) => LabelOptic "logFile" k1 (LogEnv m1) (LogEnv m2) a b Source #
Instance details Defined in Charon.Runner.Env Methods labelOptic :: Optic k1 NoIx (LogEnv m1) (LogEnv m2) a b Source #
(k1 ~ A_Lens, a ~ Namespace, b ~ Namespace) => LabelOptic "logNamespace" k1 (LogEnv m) (LogEnv m) a b Source #
Instance details Defined in Charon.Runner.Env Methods labelOptic :: Optic k1 NoIx (LogEnv m) (LogEnv m) a b Source #
Show (LogEnv m) Source #
Instance details Defined in Charon.Runner.Env Methods showsPrec :: Int -> LogEnv m -> ShowS # show :: LogEnv m -> String # showList :: [LogEnv m] -> ShowS #

data LogFile m Source #

Data for file logging.

Constructors

MkLogFile
Fields handle :: Handle File handle. logLevel :: LogLevel Level in which to log.

Instances

Instances details

(Dysfunctional "handle" k1 (LogFile m1) (LogFile m2) a b, k1 ~ A_Lens, a ~ Handle, b ~ Handle) => LabelOptic "handle" k1 (LogFile m1) (LogFile m2) a b Source #
Instance details Defined in Charon.Runner.Env Methods labelOptic :: Optic k1 NoIx (LogFile m1) (LogFile m2) a b Source #
(Dysfunctional "logLevel" k1 (LogFile m1) (LogFile m2) a b, k1 ~ A_Lens, a ~ LogLevel, b ~ LogLevel) => LabelOptic "logLevel" k1 (LogFile m1) (LogFile m2) a b Source #
Instance details Defined in Charon.Runner.Env Methods labelOptic :: Optic k1 NoIx (LogFile m1) (LogFile m2) a b Source #
Show (LogFile m) Source #
Instance details Defined in Charon.Runner.Env Methods showsPrec :: Int -> LogFile m -> ShowS # show :: LogFile m -> String # showList :: [LogFile m] -> ShowS #