Safe Haskell	None
Language	GHC2021

Shrun.Configuration.Data.CommandLogging

Contents

Types
Functions
Exceptions

Synopsis

newtype BufferLength = MkBufferLength Int
parseBufferLength :: MonadFail m => m Natural -> m BufferLength
newtype BufferTimeout = MkBufferTimeout Timeout
parseBufferTimeout :: (Alternative f, MonadFail f) => f Natural -> f Text -> f BufferTimeout
newtype ReportReadErrorsSwitch = MkReportReadErrorsSwitch Bool
data CommandLoggingP (p :: ConfigPhase) = MkCommandLoggingP {
- bufferLength :: ConfigPhaseF p BufferLength
- bufferTimeout :: ConfigPhaseF p BufferTimeout
- pollInterval :: ConfigPhaseF p PollInterval
- readSize :: ConfigPhaseF p ReadSize
- readStrategy :: ConfigPhaseF p ReadStrategy
- reportReadErrors :: SwitchF p ReportReadErrorsSwitch
}
type CommandLoggingArgs = CommandLoggingP 'ConfigPhaseArgs
type CommandLoggingToml = CommandLoggingP 'ConfigPhaseToml
type CommandLoggingMerged = CommandLoggingP 'ConfigPhaseMerged
type CommandLoggingEnv = CommandLoggingP 'ConfigPhaseEnv
mergeCommandLogging :: (HasCallStack, MonadThrow m) => Bool -> Bool -> NESeq CommandP1 -> CommandLoggingArgs -> Maybe CommandLoggingToml -> m CommandLoggingMerged
toEnv :: CommandLoggingMerged -> CommandLoggingEnv
defaultCommandLoggingMerged :: Bool -> Bool -> NESeq CommandP1 -> CommandLoggingP 'ConfigPhaseMerged
data ReadStrategyException = MkReadStrategyException

Types

Buffer length

newtype BufferLength Source #

Constructors

MkBufferLength Int

Instances

Instances details

Num BufferLength Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods (+) :: BufferLength -> BufferLength -> BufferLength # (-) :: BufferLength -> BufferLength -> BufferLength # (*) :: BufferLength -> BufferLength -> BufferLength # negate :: BufferLength -> BufferLength # abs :: BufferLength -> BufferLength # signum :: BufferLength -> BufferLength # fromInteger :: Integer -> BufferLength #
Show BufferLength Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods showsPrec :: Int -> BufferLength -> ShowS # show :: BufferLength -> String # showList :: [BufferLength] -> ShowS #
Eq BufferLength Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods (==) :: BufferLength -> BufferLength -> Bool # (/=) :: BufferLength -> BufferLength -> Bool #
Pretty BufferLength Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods pretty :: BufferLength -> Doc ann Source # prettyList :: [BufferLength] -> Doc ann Source #
Default BufferLength Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods def :: BufferLength Source #
DecodeTOML BufferLength Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods tomlDecoder :: Decoder BufferLength Source #
(k ~ An_Iso, a ~ Int, b ~ Int) => LabelOptic "unBufferLength" k BufferLength BufferLength a b Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods labelOptic :: Optic k NoIx BufferLength BufferLength a b Source #

parseBufferLength :: MonadFail m => m Natural -> m BufferLength Source #

Buffer timeout

newtype BufferTimeout Source #

Constructors

MkBufferTimeout Timeout

Instances

Instances details

FromInteger BufferTimeout Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods fromZ :: Integer -> BufferTimeout Source #
Show BufferTimeout Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods showsPrec :: Int -> BufferTimeout -> ShowS # show :: BufferTimeout -> String # showList :: [BufferTimeout] -> ShowS #
Eq BufferTimeout Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods (==) :: BufferTimeout -> BufferTimeout -> Bool # (/=) :: BufferTimeout -> BufferTimeout -> Bool #
Pretty BufferTimeout Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods pretty :: BufferTimeout -> Doc ann Source # prettyList :: [BufferTimeout] -> Doc ann Source #
Default BufferTimeout Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods def :: BufferTimeout Source #
DecodeTOML BufferTimeout Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods tomlDecoder :: Decoder BufferTimeout Source #
(k ~ An_Iso, a ~ Timeout, b ~ Timeout) => LabelOptic "unBufferTimeout" k BufferTimeout BufferTimeout a b Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods labelOptic :: Optic k NoIx BufferTimeout BufferTimeout a b Source #

parseBufferTimeout :: (Alternative f, MonadFail f) => f Natural -> f Text -> f BufferTimeout Source #

Report read errors

newtype ReportReadErrorsSwitch Source #

Switch for logging read errors

Constructors

MkReportReadErrorsSwitch Bool

Instances

Instances details

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

Main

data CommandLoggingP (p :: ConfigPhase) Source #

Holds config related to (console and file) command logging.

Constructors

MkCommandLoggingP

Fields

bufferLength :: ConfigPhaseF p BufferLength
Max log length held by the buffer for the ReadBlockLineBuffer ReadStrategy.
bufferTimeout :: ConfigPhaseF p BufferTimeout
Max time the buffer will hold a log before flushing it, for the ReadBlockLineBuffer ReadStrategy.
pollInterval :: ConfigPhaseF p PollInterval
How often to poll commands for logs, in microseconds.
readSize :: ConfigPhaseF p ReadSize
Determines the max log size we read from commands in one go. Note this is not on commandLogging or fileLogging since it affects both.
readStrategy :: ConfigPhaseF p ReadStrategy
Reading strategy.
reportReadErrors :: SwitchF p ReportReadErrorsSwitch
Determines if we should log read errors.

Instances

Instances details

Monoid CommandLoggingToml Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods mempty :: CommandLoggingToml # mappend :: CommandLoggingToml -> CommandLoggingToml -> CommandLoggingToml # mconcat :: [CommandLoggingToml] -> CommandLoggingToml #
Semigroup CommandLoggingToml Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods (<>) :: CommandLoggingToml -> CommandLoggingToml -> CommandLoggingToml # sconcat :: NonEmpty CommandLoggingToml -> CommandLoggingToml # stimes :: Integral b => b -> CommandLoggingToml -> CommandLoggingToml #
Pretty CommandLoggingMerged Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods pretty :: CommandLoggingMerged -> Doc ann Source # prettyList :: [CommandLoggingMerged] -> Doc ann Source #
Default CommandLoggingArgs Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods def :: CommandLoggingArgs Source #
DecodeTOML CommandLoggingToml Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods tomlDecoder :: Decoder CommandLoggingToml Source #
(k ~ A_Lens, a ~ ConfigPhaseF p BufferLength, b ~ ConfigPhaseF p BufferLength) => LabelOptic "bufferLength" k (CommandLoggingP p) (CommandLoggingP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods labelOptic :: Optic k NoIx (CommandLoggingP p) (CommandLoggingP p) a b Source #
(k ~ A_Lens, a ~ ConfigPhaseF p BufferTimeout, b ~ ConfigPhaseF p BufferTimeout) => LabelOptic "bufferTimeout" k (CommandLoggingP p) (CommandLoggingP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods labelOptic :: Optic k NoIx (CommandLoggingP p) (CommandLoggingP p) a b Source #
(k ~ A_Lens, a ~ ConfigPhaseF p PollInterval, b ~ ConfigPhaseF p PollInterval) => LabelOptic "pollInterval" k (CommandLoggingP p) (CommandLoggingP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods labelOptic :: Optic k NoIx (CommandLoggingP p) (CommandLoggingP p) a b Source #
(k ~ A_Lens, a ~ ConfigPhaseF p ReadSize, b ~ ConfigPhaseF p ReadSize) => LabelOptic "readSize" k (CommandLoggingP p) (CommandLoggingP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods labelOptic :: Optic k NoIx (CommandLoggingP p) (CommandLoggingP p) a b Source #
(k ~ A_Lens, a ~ ConfigPhaseF p ReadStrategy, b ~ ConfigPhaseF p ReadStrategy) => LabelOptic "readStrategy" k (CommandLoggingP p) (CommandLoggingP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods labelOptic :: Optic k NoIx (CommandLoggingP p) (CommandLoggingP p) a b Source #
(k ~ A_Lens, a ~ SwitchF p ReportReadErrorsSwitch, b ~ SwitchF p ReportReadErrorsSwitch) => LabelOptic "reportReadErrors" k (CommandLoggingP p) (CommandLoggingP p) a b Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods labelOptic :: Optic k NoIx (CommandLoggingP p) (CommandLoggingP p) a b Source #
Show (CommandLoggingP 'ConfigPhaseArgs) Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods showsPrec :: Int -> CommandLoggingP 'ConfigPhaseArgs -> ShowS # show :: CommandLoggingP 'ConfigPhaseArgs -> String # showList :: [CommandLoggingP 'ConfigPhaseArgs] -> ShowS #
Show (CommandLoggingP 'ConfigPhaseMerged) Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods showsPrec :: Int -> CommandLoggingP 'ConfigPhaseMerged -> ShowS # show :: CommandLoggingP 'ConfigPhaseMerged -> String # showList :: [CommandLoggingP 'ConfigPhaseMerged] -> ShowS #
Show (CommandLoggingP 'ConfigPhaseToml) Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods showsPrec :: Int -> CommandLoggingP 'ConfigPhaseToml -> ShowS # show :: CommandLoggingP 'ConfigPhaseToml -> String # showList :: [CommandLoggingP 'ConfigPhaseToml] -> ShowS #
Eq (CommandLoggingP 'ConfigPhaseArgs) Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods (==) :: CommandLoggingP 'ConfigPhaseArgs -> CommandLoggingP 'ConfigPhaseArgs -> Bool # (/=) :: CommandLoggingP 'ConfigPhaseArgs -> CommandLoggingP 'ConfigPhaseArgs -> Bool #
Eq (CommandLoggingP 'ConfigPhaseMerged) Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods (==) :: CommandLoggingP 'ConfigPhaseMerged -> CommandLoggingP 'ConfigPhaseMerged -> Bool # (/=) :: CommandLoggingP 'ConfigPhaseMerged -> CommandLoggingP 'ConfigPhaseMerged -> Bool #
Eq (CommandLoggingP 'ConfigPhaseToml) Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods (==) :: CommandLoggingP 'ConfigPhaseToml -> CommandLoggingP 'ConfigPhaseToml -> Bool # (/=) :: CommandLoggingP 'ConfigPhaseToml -> CommandLoggingP 'ConfigPhaseToml -> Bool #

type CommandLoggingArgs = CommandLoggingP 'ConfigPhaseArgs Source #

type CommandLoggingToml = CommandLoggingP 'ConfigPhaseToml Source #

type CommandLoggingMerged = CommandLoggingP 'ConfigPhaseMerged Source #

type CommandLoggingEnv = CommandLoggingP 'ConfigPhaseEnv Source #

Functions

mergeCommandLogging :: (HasCallStack, MonadThrow m) => Bool -> Bool -> NESeq CommandP1 -> CommandLoggingArgs -> Maybe CommandLoggingToml -> m CommandLoggingMerged Source #

Merges args and toml configs.

toEnv :: CommandLoggingMerged -> CommandLoggingEnv Source #

Creates env version from merged. Requires commands because we pick the read strategy based on the number of commands.

defaultCommandLoggingMerged :: Bool -> Bool -> NESeq CommandP1 -> CommandLoggingP 'ConfigPhaseMerged Source #

Exceptions

data ReadStrategyException Source #

Constructors

MkReadStrategyException

Instances

Instances details

Exception ReadStrategyException Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods toException :: ReadStrategyException -> SomeException # fromException :: SomeException -> Maybe ReadStrategyException # displayException :: ReadStrategyException -> String # backtraceDesired :: ReadStrategyException -> Bool #
Show ReadStrategyException Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods showsPrec :: Int -> ReadStrategyException -> ShowS # show :: ReadStrategyException -> String # showList :: [ReadStrategyException] -> ShowS #
Eq ReadStrategyException Source #
Instance details Defined in Shrun.Configuration.Data.CommandLogging Methods (==) :: ReadStrategyException -> ReadStrategyException -> Bool # (/=) :: ReadStrategyException -> ReadStrategyException -> Bool #