Safe Haskell	None
Language	GHC2021

Shrun.Configuration.Data.Core

Contents

Types
Functions
Misc

Synopsis

data CoreConfigP (p :: ConfigPhase) = MkCoreConfigP {
- init :: ConfigPhaseMaybeF p Text
- timeout :: ConfigPhaseMaybeF p Timeout
- commonLogging :: TomlOptF p (CommonLoggingP p)
- commandLogging :: TomlOptF p (CommandLoggingP p)
- consoleLogging :: TomlOptF p (ConsoleLoggingP p)
- fileLogging :: ArgsOnlyDetF p (FileLoggingP p)
- notify :: ArgsOnlyDetF p (NotifyP p)
}
type CoreConfigArgs = CoreConfigP 'ConfigPhaseArgs
type CoreConfigToml = CoreConfigP 'ConfigPhaseToml
type CoreConfigMerged = CoreConfigP 'ConfigPhaseMerged
mergeCoreConfig :: (HasCallStack, MonadTerminal m) => CoreConfigArgs -> Maybe CoreConfigToml -> m CoreConfigMerged
withCoreEnv :: (HasCallStack, MonadDBus m, MonadFileWriter m, MonadHandleWriter m, MonadPathReader m, MonadPathWriter m, MonadSTM m, MonadTerminal m, MonadThrow m) => CoreConfigMerged -> (CoreConfigEnv -> m a) -> m a
defaultMerged :: CoreConfigMerged

Types

data CoreConfigP (p :: ConfigPhase) Source #

Holds core configuration data.

Constructors

MkCoreConfigP

Fields

init :: ConfigPhaseMaybeF p Text
Shell logic to run before each command.
timeout :: ConfigPhaseMaybeF p Timeout
Timeout.
commonLogging :: TomlOptF p (CommonLoggingP p)
Holds common logging config.
commandLogging :: TomlOptF p (CommandLoggingP p)
Command log config.
consoleLogging :: TomlOptF p (ConsoleLoggingP p)
Holds console logging config.
fileLogging :: ArgsOnlyDetF p (FileLoggingP p)
File log config.
notify :: ArgsOnlyDetF p (NotifyP p)
Notify config.

Instances

Instances details

(k ~ A_Lens, a ~ TomlOptF p (CommandLoggingP p), b ~ TomlOptF p (CommandLoggingP p)) => LabelOptic "commandLogging" k (CoreConfigP p) (CoreConfigP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods labelOptic :: Optic k NoIx (CoreConfigP p) (CoreConfigP p) a b Source #
(k ~ A_Lens, a ~ TomlOptF p (CommonLoggingP p), b ~ TomlOptF p (CommonLoggingP p)) => LabelOptic "commonLogging" k (CoreConfigP p) (CoreConfigP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods labelOptic :: Optic k NoIx (CoreConfigP p) (CoreConfigP p) a b Source #
(k ~ A_Lens, a ~ TomlOptF p (ConsoleLoggingP p), b ~ TomlOptF p (ConsoleLoggingP p)) => LabelOptic "consoleLogging" k (CoreConfigP p) (CoreConfigP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods labelOptic :: Optic k NoIx (CoreConfigP p) (CoreConfigP p) a b Source #
(k ~ A_Lens, a ~ ArgsOnlyDetF p (FileLoggingP p), b ~ ArgsOnlyDetF p (FileLoggingP p)) => LabelOptic "fileLogging" k (CoreConfigP p) (CoreConfigP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods labelOptic :: Optic k NoIx (CoreConfigP p) (CoreConfigP p) a b Source #
(k ~ A_Lens, a ~ ConfigPhaseMaybeF p Text, b ~ ConfigPhaseMaybeF p Text) => LabelOptic "init" k (CoreConfigP p) (CoreConfigP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods labelOptic :: Optic k NoIx (CoreConfigP p) (CoreConfigP p) a b Source #
(k ~ A_Lens, a ~ ArgsOnlyDetF p (NotifyP p), b ~ ArgsOnlyDetF p (NotifyP p)) => LabelOptic "notify" k (CoreConfigP p) (CoreConfigP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods labelOptic :: Optic k NoIx (CoreConfigP p) (CoreConfigP p) a b Source #
(k ~ A_Lens, a ~ ConfigPhaseMaybeF p Timeout, b ~ ConfigPhaseMaybeF p Timeout) => LabelOptic "timeout" k (CoreConfigP p) (CoreConfigP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods labelOptic :: Optic k NoIx (CoreConfigP p) (CoreConfigP p) a b Source #
Show (CoreConfigP 'ConfigPhaseArgs) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods showsPrec :: Int -> CoreConfigP 'ConfigPhaseArgs -> ShowS # show :: CoreConfigP 'ConfigPhaseArgs -> String # showList :: [CoreConfigP 'ConfigPhaseArgs] -> ShowS #
Show (CoreConfigP 'ConfigPhaseMerged) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods showsPrec :: Int -> CoreConfigP 'ConfigPhaseMerged -> ShowS # show :: CoreConfigP 'ConfigPhaseMerged -> String # showList :: [CoreConfigP 'ConfigPhaseMerged] -> ShowS #
Show (CoreConfigP 'ConfigPhaseToml) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods showsPrec :: Int -> CoreConfigP 'ConfigPhaseToml -> ShowS # show :: CoreConfigP 'ConfigPhaseToml -> String # showList :: [CoreConfigP 'ConfigPhaseToml] -> ShowS #
Eq (CoreConfigP 'ConfigPhaseArgs) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods (==) :: CoreConfigP 'ConfigPhaseArgs -> CoreConfigP 'ConfigPhaseArgs -> Bool # (/=) :: CoreConfigP 'ConfigPhaseArgs -> CoreConfigP 'ConfigPhaseArgs -> Bool #
Eq (CoreConfigP 'ConfigPhaseMerged) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods (==) :: CoreConfigP 'ConfigPhaseMerged -> CoreConfigP 'ConfigPhaseMerged -> Bool # (/=) :: CoreConfigP 'ConfigPhaseMerged -> CoreConfigP 'ConfigPhaseMerged -> Bool #
Eq (CoreConfigP 'ConfigPhaseToml) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods (==) :: CoreConfigP 'ConfigPhaseToml -> CoreConfigP 'ConfigPhaseToml -> Bool # (/=) :: CoreConfigP 'ConfigPhaseToml -> CoreConfigP 'ConfigPhaseToml -> Bool #
(Default (ConfigPhaseMaybeF p Text), Default (ConfigPhaseMaybeF p Timeout), Default (TomlOptF p (CommonLoggingP p)), Default (TomlOptF p (CommandLoggingP p)), Default (TomlOptF p (ConsoleLoggingP p)), Default (ArgsOnlyDetF p (FileLoggingP p)), Default (ArgsOnlyDetF p (NotifyP p))) => Default (CoreConfigP p) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods def :: CoreConfigP p Source #

type CoreConfigArgs = CoreConfigP 'ConfigPhaseArgs Source #

type CoreConfigToml = CoreConfigP 'ConfigPhaseToml Source #

type CoreConfigMerged = CoreConfigP 'ConfigPhaseMerged Source #

Functions

mergeCoreConfig :: (HasCallStack, MonadTerminal m) => CoreConfigArgs -> Maybe CoreConfigToml -> m CoreConfigMerged Source #

withCoreEnv :: (HasCallStack, MonadDBus m, MonadFileWriter m, MonadHandleWriter m, MonadPathReader m, MonadPathWriter m, MonadSTM m, MonadTerminal m, MonadThrow m) => CoreConfigMerged -> (CoreConfigEnv -> m a) -> m a Source #

Given a merged CoreConfig, constructs a ConfigEnv and calls the continuation.

Misc

defaultMerged :: CoreConfigMerged Source #