Safe Haskell	None
Language	GHC2021

Shrun.Configuration.Data.FileLogging

Synopsis

data FileLogInitP (p :: ConfigPhase) = MkFileLogInitP {
- path :: FileLogPathF p
- mode :: ConfigPhaseF p FileMode
- sizeMode :: ConfigPhaseF p FileSizeMode
}
data FileLogOpened = MkFileLogOpened {
- handle :: ~Handle
- queue :: ~(TBQueue FileLog)
}
data FileLoggingP (p :: ConfigPhase) = MkFileLoggingP {
- file :: FileLogFileF p
- commandNameTrunc :: ConfigPhaseMaybeF p (Truncation 'TruncCommandName)
- deleteOnSuccess :: SwitchF p DeleteOnSuccessSwitch
- lineTrunc :: LineTruncF p
- stripControl :: ConfigPhaseF p FileLogStripControl
}
type FileLoggingArgs = FileLoggingP 'ConfigPhaseArgs
type FileLoggingToml = FileLoggingP 'ConfigPhaseToml
type FileLoggingMerged = FileLoggingP 'ConfigPhaseMerged
type FileLoggingEnv = FileLoggingP 'ConfigPhaseEnv
data DeleteOnSuccessSwitch
- = DeleteOnSuccessOff
- | DeleteOnSuccessOn
mergeFileLogging :: (HasCallStack, MonadTerminal m) => FileLoggingArgs -> Maybe FileLoggingToml -> m (Maybe FileLoggingMerged)
withFileLoggingEnv :: (HasCallStack, MonadFileWriter m, MonadHandleWriter m, MonadPathReader m, MonadPathWriter m, MonadSTM m, MonadTerminal m) => Maybe FileLoggingMerged -> (Maybe FileLoggingEnv -> m a) -> m a

Documentation

data FileLogInitP (p :: ConfigPhase) Source #

Initial file log params, for usage before we create the final Env.

Constructors

MkFileLogInitP
Fields path :: FileLogPathF p Optional path to log file. mode :: ConfigPhaseF p FileMode Mode to use with the file log. sizeMode :: ConfigPhaseF p FileSizeMode Threshold for when we should warn about the log file size.

Instances

Instances details

(k ~ A_Lens, a ~ ConfigPhaseF p FileMode, b ~ ConfigPhaseF p FileMode) => LabelOptic "mode" k (FileLogInitP p) (FileLogInitP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods labelOptic :: Optic k NoIx (FileLogInitP p) (FileLogInitP p) a b Source #
(k ~ A_Lens, a ~ FileLogPathF p, b ~ FileLogPathF p) => LabelOptic "path" k (FileLogInitP p) (FileLogInitP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods labelOptic :: Optic k NoIx (FileLogInitP p) (FileLogInitP p) a b Source #
(k ~ A_Lens, a ~ ConfigPhaseF p FileSizeMode, b ~ ConfigPhaseF p FileSizeMode) => LabelOptic "sizeMode" k (FileLogInitP p) (FileLogInitP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods labelOptic :: Optic k NoIx (FileLogInitP p) (FileLogInitP p) a b Source #

data FileLogOpened Source #

Params after we have opened the file for logging.

Constructors

MkFileLogOpened
Fields handle :: ~Handle File handle. queue :: ~(TBQueue FileLog) File log queue.

Instances

Instances details

(k ~ A_Lens, a ~ Handle, b ~ Handle) => LabelOptic "handle" k FileLogOpened FileLogOpened a b Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods labelOptic :: Optic k NoIx FileLogOpened FileLogOpened a b Source #
(k ~ A_Lens, a ~ TBQueue FileLog, b ~ TBQueue FileLog) => LabelOptic "queue" k FileLogOpened FileLogOpened a b Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods labelOptic :: Optic k NoIx FileLogOpened FileLogOpened a b Source #

data FileLoggingP (p :: ConfigPhase) Source #

Holds file logging config.

Constructors

MkFileLoggingP

Fields

file :: FileLogFileF p
File-related params.
commandNameTrunc :: ConfigPhaseMaybeF p (Truncation 'TruncCommandName)
The max number of command characters to display in the file logs.
deleteOnSuccess :: SwitchF p DeleteOnSuccessSwitch
If active, deletes the log file upon success.
lineTrunc :: LineTruncF p
Determines to what extent we should remove control characters from file logs.
stripControl :: ConfigPhaseF p FileLogStripControl
Strip control

Instances

Instances details

DecodeTOML FileLoggingToml Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods tomlDecoder :: Decoder FileLoggingToml Source #
(k ~ A_Lens, a ~ ConfigPhaseMaybeF p (Truncation 'TruncCommandName), b ~ ConfigPhaseMaybeF p (Truncation 'TruncCommandName)) => LabelOptic "commandNameTrunc" k (FileLoggingP p) (FileLoggingP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods labelOptic :: Optic k NoIx (FileLoggingP p) (FileLoggingP p) a b Source #
(k ~ A_Lens, a ~ SwitchF p DeleteOnSuccessSwitch, b ~ SwitchF p DeleteOnSuccessSwitch) => LabelOptic "deleteOnSuccess" k (FileLoggingP p) (FileLoggingP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods labelOptic :: Optic k NoIx (FileLoggingP p) (FileLoggingP p) a b Source #
(k ~ A_Lens, a ~ FileLogFileF p, b ~ FileLogFileF p) => LabelOptic "file" k (FileLoggingP p) (FileLoggingP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods labelOptic :: Optic k NoIx (FileLoggingP p) (FileLoggingP p) a b Source #
(k ~ A_Lens, a ~ LineTruncF p, b ~ LineTruncF p) => LabelOptic "lineTrunc" k (FileLoggingP p) (FileLoggingP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods labelOptic :: Optic k NoIx (FileLoggingP p) (FileLoggingP p) a b Source #
(k ~ A_Lens, a ~ ConfigPhaseF p FileLogStripControl, b ~ ConfigPhaseF p FileLogStripControl) => LabelOptic "stripControl" k (FileLoggingP p) (FileLoggingP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods labelOptic :: Optic k NoIx (FileLoggingP p) (FileLoggingP p) a b Source #
Show (FileLoggingP 'ConfigPhaseArgs) Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods showsPrec :: Int -> FileLoggingP 'ConfigPhaseArgs -> ShowS # show :: FileLoggingP 'ConfigPhaseArgs -> String # showList :: [FileLoggingP 'ConfigPhaseArgs] -> ShowS #
Show (FileLoggingP 'ConfigPhaseMerged) Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods showsPrec :: Int -> FileLoggingP 'ConfigPhaseMerged -> ShowS # show :: FileLoggingP 'ConfigPhaseMerged -> String # showList :: [FileLoggingP 'ConfigPhaseMerged] -> ShowS #
Show (FileLoggingP 'ConfigPhaseToml) Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods showsPrec :: Int -> FileLoggingP 'ConfigPhaseToml -> ShowS # show :: FileLoggingP 'ConfigPhaseToml -> String # showList :: [FileLoggingP 'ConfigPhaseToml] -> ShowS #
Eq (FileLoggingP 'ConfigPhaseArgs) Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods (==) :: FileLoggingP 'ConfigPhaseArgs -> FileLoggingP 'ConfigPhaseArgs -> Bool # (/=) :: FileLoggingP 'ConfigPhaseArgs -> FileLoggingP 'ConfigPhaseArgs -> Bool #
Eq (FileLoggingP 'ConfigPhaseMerged) Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods (==) :: FileLoggingP 'ConfigPhaseMerged -> FileLoggingP 'ConfigPhaseMerged -> Bool # (/=) :: FileLoggingP 'ConfigPhaseMerged -> FileLoggingP 'ConfigPhaseMerged -> Bool #
Eq (FileLoggingP 'ConfigPhaseToml) Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods (==) :: FileLoggingP 'ConfigPhaseToml -> FileLoggingP 'ConfigPhaseToml -> Bool # (/=) :: FileLoggingP 'ConfigPhaseToml -> FileLoggingP 'ConfigPhaseToml -> Bool #
(Default (FileLogFileF p), Default (ConfigPhaseMaybeF p (Truncation 'TruncCommandName)), Default (SwitchF p DeleteOnSuccessSwitch), Default (LineTruncF p), Default (ConfigPhaseF p FileLogStripControl)) => Default (FileLoggingP p) Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods def :: FileLoggingP p Source #

type FileLoggingArgs = FileLoggingP 'ConfigPhaseArgs Source #

type FileLoggingToml = FileLoggingP 'ConfigPhaseToml Source #

type FileLoggingMerged = FileLoggingP 'ConfigPhaseMerged Source #

type FileLoggingEnv = FileLoggingP 'ConfigPhaseEnv Source #

data DeleteOnSuccessSwitch Source #

Switch for deleting the log file upon success.

Constructors

DeleteOnSuccessOff
DeleteOnSuccessOn

Instances

Instances details

Show DeleteOnSuccessSwitch Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods showsPrec :: Int -> DeleteOnSuccessSwitch -> ShowS # show :: DeleteOnSuccessSwitch -> String # showList :: [DeleteOnSuccessSwitch] -> ShowS #
Eq DeleteOnSuccessSwitch Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods (==) :: DeleteOnSuccessSwitch -> DeleteOnSuccessSwitch -> Bool # (/=) :: DeleteOnSuccessSwitch -> DeleteOnSuccessSwitch -> Bool #
Default DeleteOnSuccessSwitch Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods def :: DeleteOnSuccessSwitch Source #
(k ~ An_Iso, a ~ Bool, b ~ Bool) => LabelOptic "boolIso" k DeleteOnSuccessSwitch DeleteOnSuccessSwitch a b Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods labelOptic :: Optic k NoIx DeleteOnSuccessSwitch DeleteOnSuccessSwitch a b Source #

mergeFileLogging :: (HasCallStack, MonadTerminal m) => FileLoggingArgs -> Maybe FileLoggingToml -> m (Maybe FileLoggingMerged) Source #

Merges args and toml configs.

withFileLoggingEnv :: (HasCallStack, MonadFileWriter m, MonadHandleWriter m, MonadPathReader m, MonadPathWriter m, MonadSTM m, MonadTerminal m) => Maybe FileLoggingMerged -> (Maybe FileLoggingEnv -> m a) -> m a Source #

Given merged FileLogging config, constructs a FileLoggingEnv and calls the continuation.