Safe Haskell	None
Language	GHC2021

Shrun.Configuration.Data.FileLogging

Contents

Misc

Synopsis

data FileLogInitP (p :: ConfigPhase) = MkFileLogInitP {
- path :: FileLogPathF p
- sizeMode :: ConfigPhaseF p FileSizeMode
}
data FileLogOpened = MkFileLogOpened {
- handle :: ~LockedHandleW
- path :: OsPath
- queue :: ~(TBQueue FileLog)
}
data FileLoggingP (p :: ConfigPhase) = MkFileLoggingP {
- file :: FileLogFileF p
- commandNameTrunc :: ConfigPhaseDisabledMaybeF p (Truncation 'TruncCommandName)
- deleteOnSuccess :: SwitchF p DeleteOnSuccessSwitch
- lineTrunc :: LineTruncF p
- mode :: ConfigPhaseF p FileMode
- multi :: FileLogMultiF p
- stripControl :: ConfigPhaseF p FileLogStripControl
}
type FileLoggingArgs = FileLoggingP 'ConfigPhaseArgs
type FileLoggingToml = FileLoggingP 'ConfigPhaseToml
type FileLoggingMerged = FileLoggingP 'ConfigPhaseMerged
type FileLoggingEnv = FileLoggingP 'ConfigPhaseEnv
newtype DeleteOnSuccessSwitch = MkDeleteOnSuccessSwitch Bool
newtype FileLogMultiSwitch = MkFileLogMultiSwitch Bool
mergeFileLogging :: (HasCallStack, MonadCatch m, MonadIORef m, MonadTerminal m) => NESeq CommandP1 -> IORef DetectResult -> FileLoggingArgs -> Maybe FileLoggingToml -> m (Maybe FileLoggingMerged)
withFileLoggingEnv :: (HasCallStack, MonadAtomic m, MonadFileWriter m, MonadHandleWriter m, MonadMask m, MonadPathReader m, MonadPathWriter m, MonadPosixFiles m, MonadTerminal m) => Maybe FileLoggingMerged -> (Maybe FileLoggingEnv -> m a) -> m a
createMultiLogFile :: (HasCallStack, MonadAtomic m, MonadHandleWriter m, MonadPathReader m, MonadPosixFiles m, MonadThrow m) => TVar Word16 -> FileMode -> OsPath -> m OsPath

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. sizeMode :: ConfigPhaseF p FileSizeMode Threshold for when we should warn about the log file size.

Instances

Instances details

(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 :: ~LockedHandleW File handle. path :: OsPath File path. queue :: ~(TBQueue FileLog) File log queue.

Instances

Instances details

(k ~ A_Lens, a ~ LockedHandleW, b ~ LockedHandleW) => 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 ~ OsPath, b ~ OsPath) => LabelOptic "path" 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 :: ConfigPhaseDisabledMaybeF 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.
mode :: ConfigPhaseF p FileMode
Mode to use with the file log.
multi :: FileLogMultiF p
Switch for multi logs. At the env stage, this is a counter for the file name index.
stripControl :: ConfigPhaseF p FileLogStripControl
Strip control

Instances

Instances details

Monoid FileLoggingToml Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods mempty :: FileLoggingToml # mappend :: FileLoggingToml -> FileLoggingToml -> FileLoggingToml # mconcat :: [FileLoggingToml] -> FileLoggingToml #
Semigroup FileLoggingToml Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods (<>) :: FileLoggingToml -> FileLoggingToml -> FileLoggingToml # sconcat :: NonEmpty FileLoggingToml -> FileLoggingToml # stimes :: Integral b => b -> FileLoggingToml -> FileLoggingToml #
Pretty FileLoggingMerged Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods pretty :: FileLoggingMerged -> Doc ann Source # prettyList :: [FileLoggingMerged] -> Doc ann Source #
Default FileLoggingArgs Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods def :: FileLoggingArgs Source #
DecodeTOML FileLoggingToml Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods tomlDecoder :: Decoder FileLoggingToml Source #
(k ~ A_Lens, a ~ ConfigPhaseDisabledMaybeF p (Truncation 'TruncCommandName), b ~ ConfigPhaseDisabledMaybeF 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 FileMode, b ~ ConfigPhaseF p FileMode) => LabelOptic "mode" 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 ~ FileLogMultiF p, b ~ FileLogMultiF p) => LabelOptic "multi" 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 #

type FileLoggingArgs = FileLoggingP 'ConfigPhaseArgs Source #

type FileLoggingToml = FileLoggingP 'ConfigPhaseToml Source #

type FileLoggingMerged = FileLoggingP 'ConfigPhaseMerged Source #

type FileLoggingEnv = FileLoggingP 'ConfigPhaseEnv Source #

newtype DeleteOnSuccessSwitch Source #

Switch for deleting the log file upon success.

Constructors

MkDeleteOnSuccessSwitch Bool

Instances

Instances details

Bounded DeleteOnSuccessSwitch Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods minBound :: DeleteOnSuccessSwitch # maxBound :: DeleteOnSuccessSwitch #
Enum DeleteOnSuccessSwitch Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods succ :: DeleteOnSuccessSwitch -> DeleteOnSuccessSwitch # pred :: DeleteOnSuccessSwitch -> DeleteOnSuccessSwitch # toEnum :: Int -> DeleteOnSuccessSwitch # fromEnum :: DeleteOnSuccessSwitch -> Int # enumFrom :: DeleteOnSuccessSwitch -> [DeleteOnSuccessSwitch] # enumFromThen :: DeleteOnSuccessSwitch -> DeleteOnSuccessSwitch -> [DeleteOnSuccessSwitch] # enumFromTo :: DeleteOnSuccessSwitch -> DeleteOnSuccessSwitch -> [DeleteOnSuccessSwitch] # enumFromThenTo :: DeleteOnSuccessSwitch -> DeleteOnSuccessSwitch -> DeleteOnSuccessSwitch -> [DeleteOnSuccessSwitch] #
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 #
Pretty DeleteOnSuccessSwitch Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods pretty :: DeleteOnSuccessSwitch -> Doc ann Source # prettyList :: [DeleteOnSuccessSwitch] -> Doc ann Source #
Default DeleteOnSuccessSwitch Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods def :: DeleteOnSuccessSwitch Source #
DecodeTOML DeleteOnSuccessSwitch Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods tomlDecoder :: Decoder DeleteOnSuccessSwitch Source #
(k ~ An_Iso, a ~ Bool, b ~ Bool) => LabelOptic "unDeleteOnSuccessSwitch" k DeleteOnSuccessSwitch DeleteOnSuccessSwitch a b Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods labelOptic :: Optic k NoIx DeleteOnSuccessSwitch DeleteOnSuccessSwitch a b Source #

newtype FileLogMultiSwitch Source #

Switch for logging to multiple files.

Constructors

MkFileLogMultiSwitch Bool

Instances

Instances details

Bounded FileLogMultiSwitch Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods minBound :: FileLogMultiSwitch # maxBound :: FileLogMultiSwitch #
Enum FileLogMultiSwitch Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods succ :: FileLogMultiSwitch -> FileLogMultiSwitch # pred :: FileLogMultiSwitch -> FileLogMultiSwitch # toEnum :: Int -> FileLogMultiSwitch # fromEnum :: FileLogMultiSwitch -> Int # enumFrom :: FileLogMultiSwitch -> [FileLogMultiSwitch] # enumFromThen :: FileLogMultiSwitch -> FileLogMultiSwitch -> [FileLogMultiSwitch] # enumFromTo :: FileLogMultiSwitch -> FileLogMultiSwitch -> [FileLogMultiSwitch] # enumFromThenTo :: FileLogMultiSwitch -> FileLogMultiSwitch -> FileLogMultiSwitch -> [FileLogMultiSwitch] #
Show FileLogMultiSwitch Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods showsPrec :: Int -> FileLogMultiSwitch -> ShowS # show :: FileLogMultiSwitch -> String # showList :: [FileLogMultiSwitch] -> ShowS #
Eq FileLogMultiSwitch Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods (==) :: FileLogMultiSwitch -> FileLogMultiSwitch -> Bool # (/=) :: FileLogMultiSwitch -> FileLogMultiSwitch -> Bool #
Pretty FileLogMultiSwitch Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods pretty :: FileLogMultiSwitch -> Doc ann Source # prettyList :: [FileLogMultiSwitch] -> Doc ann Source #
Default FileLogMultiSwitch Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods def :: FileLogMultiSwitch Source #
DecodeTOML FileLogMultiSwitch Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods tomlDecoder :: Decoder FileLogMultiSwitch Source #
(k ~ An_Iso, a ~ Bool, b ~ Bool) => LabelOptic "unFileLogMultiSwitch" k FileLogMultiSwitch FileLogMultiSwitch a b Source #
Instance details Defined in Shrun.Configuration.Data.FileLogging Methods labelOptic :: Optic k NoIx FileLogMultiSwitch FileLogMultiSwitch a b Source #

mergeFileLogging :: (HasCallStack, MonadCatch m, MonadIORef m, MonadTerminal m) => NESeq CommandP1 -> IORef DetectResult -> FileLoggingArgs -> Maybe FileLoggingToml -> m (Maybe FileLoggingMerged) Source #

Merges args and toml configs.

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

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

Misc

createMultiLogFile :: (HasCallStack, MonadAtomic m, MonadHandleWriter m, MonadPathReader m, MonadPosixFiles m, MonadThrow m) => TVar Word16 -> FileMode -> OsPath -> m OsPath Source #

Like createLogFile, but for multi logs, which has different semantics.

While we allow overwriting / appending to existing files, what we absolutely do not want to allow is two shrun commands actively logging to the same file. This would mean logs get jumbled up.

Therefore, if we encounter an extant file, we use the TVar counter to append a number. This index is unique across all shrun commands, hence we will not have interference.