Safe Haskell	Safe-Inferred
Language	GHC2021

Charon.Runner.Args

Description

Provides CLI args functionality.

Synopsis

getArgs :: MonadOptparse m => m Args
data Args = MkArgs {
- tomlConfigPath :: TomlConfigPath
- backend :: Maybe Backend
- logLevel :: !(Maybe (Maybe LogLevel))
- logSizeMode :: Maybe FileSizeMode
- trashHome :: !(Maybe (PathI TrashHome))
- command :: CommandP1
}
data TomlConfigPath
- = TomlNone
- | TomlDefault
- | TomlPath OsPath

Documentation

getArgs :: MonadOptparse m => m Args Source #

Retrieves CLI args.

data Args Source #

CLI args.

Constructors

MkArgs

Fields

tomlConfigPath :: TomlConfigPath
Path to toml config.
backend :: Maybe Backend
Backend to use.
logLevel :: !(Maybe (Maybe LogLevel))
The file logging level. The double Maybe is so we distinguish between unspecified (Nothing) and explicitly disabled (Just Nothing).
logSizeMode :: Maybe FileSizeMode
Whether to warn/delete for large log files.
trashHome :: !(Maybe (PathI TrashHome))
Path to trash home.
command :: CommandP1
Command to run.

Instances

Instances details

Generic Args Source #
Instance details Defined in Charon.Runner.Args Associated Types type Rep Args :: Type -> Type # Methods from :: Args -> Rep Args x # to :: Rep Args x -> Args #
Show Args Source #
Instance details Defined in Charon.Runner.Args Methods showsPrec :: Int -> Args -> ShowS # show :: Args -> String # showList :: [Args] -> ShowS #
Eq Args Source #
Instance details Defined in Charon.Runner.Args Methods (==) :: Args -> Args -> Bool # (/=) :: Args -> Args -> Bool #
(k ~ A_Lens, a ~ Maybe Backend, b ~ Maybe Backend) => LabelOptic "backend" k Args Args a b Source #
Instance details Defined in Charon.Runner.Args Methods labelOptic :: Optic k NoIx Args Args a b Source #
(k ~ A_Lens, a ~ CommandP1, b ~ CommandP1) => LabelOptic "command" k Args Args a b Source #
Instance details Defined in Charon.Runner.Args Methods labelOptic :: Optic k NoIx Args Args a b Source #
(k ~ A_Lens, a ~ Maybe (Maybe LogLevel), b ~ Maybe (Maybe LogLevel)) => LabelOptic "logLevel" k Args Args a b Source #
Instance details Defined in Charon.Runner.Args Methods labelOptic :: Optic k NoIx Args Args a b Source #
(k ~ A_Lens, a ~ Maybe FileSizeMode, b ~ Maybe FileSizeMode) => LabelOptic "logSizeMode" k Args Args a b Source #
Instance details Defined in Charon.Runner.Args Methods labelOptic :: Optic k NoIx Args Args a b Source #
(k ~ A_Lens, a ~ TomlConfigPath, b ~ TomlConfigPath) => LabelOptic "tomlConfigPath" k Args Args a b Source #
Instance details Defined in Charon.Runner.Args Methods labelOptic :: Optic k NoIx Args Args a b Source #
(k ~ A_Lens, a ~ Maybe (PathI 'TrashHome), b ~ Maybe (PathI 'TrashHome)) => LabelOptic "trashHome" k Args Args a b Source #
Instance details Defined in Charon.Runner.Args Methods labelOptic :: Optic k NoIx Args Args a b Source #
type Rep Args Source #
Instance details Defined in Charon.Runner.Args type Rep Args = D1 ('MetaData "Args" "Charon.Runner.Args" "charon-0.1-inplace" 'False) (C1 ('MetaCons "MkArgs" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tomlConfigPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TomlConfigPath) :: (S1 ('MetaSel ('Just "backend") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Backend)) :: S1 ('MetaSel ('Just "logLevel") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (Maybe LogLevel))))) :: (S1 ('MetaSel ('Just "logSizeMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileSizeMode)) :: (S1 ('MetaSel ('Just "trashHome") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (PathI 'TrashHome))) :*: S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CommandP1)))))

data TomlConfigPath Source #

Toml path config.

Constructors

TomlNone	Do not use any Toml config.
TomlDefault	Attempts to read the Toml file at the default path.
TomlPath OsPath	Path to Toml file.

Instances

Instances details

Show TomlConfigPath Source #
Instance details Defined in Charon.Runner.Args Methods showsPrec :: Int -> TomlConfigPath -> ShowS # show :: TomlConfigPath -> String # showList :: [TomlConfigPath] -> ShowS #
Eq TomlConfigPath Source #
Instance details Defined in Charon.Runner.Args Methods (==) :: TomlConfigPath -> TomlConfigPath -> Bool # (/=) :: TomlConfigPath -> TomlConfigPath -> Bool #