Safe Haskell	None
Language	GHC2021

Shrun.Configuration.Data.ConsoleLogging.TimerFormat

Contents

Type
Parsing
Formatting

Description

Provides the TimerFormat type.

Synopsis

data TimerFormat
- = DigitalCompact
- | DigitalFull
- | ProseCompact
- | ProseFull
parseTimerFormat :: MonadFail m => m Text -> m TimerFormat
timerFormatMeta :: IsString a => (Bool, [a])
formatRelativeTime :: TimerFormat -> RelativeTime -> UnlinedText
formatSeconds :: TimerFormat -> Natural -> UnlinedText

Type

data TimerFormat Source #

Determines how to format the timer.

Constructors

DigitalCompact
DigitalFull
ProseCompact
ProseFull

Instances

Instances details

Bounded TimerFormat Source #
Instance details Defined in Shrun.Configuration.Data.ConsoleLogging.TimerFormat Methods minBound :: TimerFormat # maxBound :: TimerFormat #
Enum TimerFormat Source #
Instance details Defined in Shrun.Configuration.Data.ConsoleLogging.TimerFormat Methods succ :: TimerFormat -> TimerFormat # pred :: TimerFormat -> TimerFormat # toEnum :: Int -> TimerFormat # fromEnum :: TimerFormat -> Int # enumFrom :: TimerFormat -> [TimerFormat] # enumFromThen :: TimerFormat -> TimerFormat -> [TimerFormat] # enumFromTo :: TimerFormat -> TimerFormat -> [TimerFormat] # enumFromThenTo :: TimerFormat -> TimerFormat -> TimerFormat -> [TimerFormat] #
Show TimerFormat Source #
Instance details Defined in Shrun.Configuration.Data.ConsoleLogging.TimerFormat Methods showsPrec :: Int -> TimerFormat -> ShowS # show :: TimerFormat -> String # showList :: [TimerFormat] -> ShowS #
Eq TimerFormat Source #
Instance details Defined in Shrun.Configuration.Data.ConsoleLogging.TimerFormat Methods (==) :: TimerFormat -> TimerFormat -> Bool # (/=) :: TimerFormat -> TimerFormat -> Bool #
Pretty TimerFormat Source #
Instance details Defined in Shrun.Configuration.Data.ConsoleLogging.TimerFormat Methods pretty :: TimerFormat -> Doc ann Source # prettyList :: [TimerFormat] -> Doc ann Source #
Default TimerFormat Source #
Instance details Defined in Shrun.Configuration.Data.ConsoleLogging.TimerFormat Methods def :: TimerFormat Source #
DecodeTOML TimerFormat Source #
Instance details Defined in Shrun.Configuration.Data.ConsoleLogging.TimerFormat Methods tomlDecoder :: Decoder TimerFormat Source #

Parsing

parseTimerFormat :: MonadFail m => m Text -> m TimerFormat Source #

Parse timer format.

timerFormatMeta :: IsString a => (Bool, [a]) Source #

Available TimerFormat strings.

Formatting

formatRelativeTime :: TimerFormat -> RelativeTime -> UnlinedText Source #

Formats a relative time.

formatSeconds :: TimerFormat -> Natural -> UnlinedText Source #

Formats a relative time seconds.