OptEnvConf.Args

Public API

data Args

An abstraction over '[String]' that makes it easier to implement consumeArgument, consumeOption and consumeSwitch.

In order to implement folded short dashed options, we need to use tombstones for consumed argumentsn

Constructors

Args

Fields

• argsBefore :: [Tomb Arg]
• argsAfter :: [Tomb Arg]

Instances

Generic Args

Defined in OptEnvConf.Args

Associated Types

type Rep Args :: Type -> Type

Methods

from :: Args -> Rep Args x

to :: Rep Args x -> Args

IsList Args

Defined in OptEnvConf.Args

Associated Types

type Item Args

Methods

fromList :: [Item Args] -> Args

fromListN :: Int -> [Item Args] -> Args

toList :: Args -> [Item Args]

Show Args

Defined in OptEnvConf.Args

Methods

showsPrec :: Int -> Args -> ShowS

show :: Args -> String

showList :: [Args] -> ShowS

Eq Args

Defined in OptEnvConf.Args

Methods

(==) :: Args -> Args -> Bool

(/=) :: Args -> Args -> Bool

Validity Args

Defined in OptEnvConf.Args

Methods

validate :: Args -> Validation

type Rep Args

Defined in OptEnvConf.Args

type Rep Args = D1 ('MetaData "Args" "OptEnvConf.Args" "opt-env-conf-0.8.0.0-GWst156WP6fE4VnsM7jUpY" 'False) (C1 ('MetaCons "Args" 'PrefixI 'True) (S1 ('MetaSel ('Just "argsBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Tomb Arg]) :*: S1 ('MetaSel ('Just "argsAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Tomb Arg])))

type Item Args

Defined in OptEnvConf.Args

type Item Args = Tomb Arg

emptyArgs :: Args

Empty list of arguments

parseArgs :: [String] -> Args

Create Args with all-live arguments and cursor at the start.

consumeArgument :: Args -> [(Maybe String, Args)]

Consume a single positional argument.

The result are all possible results

consumeOption :: [Dashed] -> Args -> Maybe (String, Args)

Consume an option.

This supports:

• ["-f", "foo"]

• ["--foo", "foo"]

• ["-df", "foo"]

• ["--foo=foo"]

• ["-ffoo"]

consumeSwitch :: [Dashed] -> Args -> Maybe Args

Consume a switch.

This supports:

• ["-f"]

• ["--foo"]

• ["-df"]

recogniseLeftovers :: Args -> Maybe (NonEmpty String)

Internals

data Tomb a

Tombstone for leftovers of consumed arguments

Constructors

Dead

Consumed

Live a

Unconsumed

Instances

IsString a => IsString (Tomb a)

Defined in OptEnvConf.Args

Methods

fromString :: String -> Tomb a

Generic (Tomb a)

Defined in OptEnvConf.Args

Associated Types

type Rep (Tomb a) :: Type -> Type

Methods

from :: Tomb a -> Rep (Tomb a) x

to :: Rep (Tomb a) x -> Tomb a

Show a => Show (Tomb a)

Defined in OptEnvConf.Args

Methods

showsPrec :: Int -> Tomb a -> ShowS

show :: Tomb a -> String

showList :: [Tomb a] -> ShowS

Eq a => Eq (Tomb a)

Defined in OptEnvConf.Args

Methods

(==) :: Tomb a -> Tomb a -> Bool

(/=) :: Tomb a -> Tomb a -> Bool

Validity a => Validity (Tomb a)

Defined in OptEnvConf.Args

Methods

validate :: Tomb a -> Validation

type Rep (Tomb a)

Defined in OptEnvConf.Args

type Rep (Tomb a) = D1 ('MetaData "Tomb" "OptEnvConf.Args" "opt-env-conf-0.8.0.0-GWst156WP6fE4VnsM7jUpY" 'False) (C1 ('MetaCons "Dead" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Live" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

data Arg

Constructors

ArgBareDoubleDash

ArgBareDash

ArgDashed !Bool !(NonEmpty Char)

ArgPlain !String

Instances

IsString Arg

Defined in OptEnvConf.Args

Methods

fromString :: String -> Arg

Generic Arg

Defined in OptEnvConf.Args

Associated Types

type Rep Arg :: Type -> Type

Methods

from :: Arg -> Rep Arg x

to :: Rep Arg x -> Arg

Show Arg

Defined in OptEnvConf.Args

Methods

showsPrec :: Int -> Arg -> ShowS

show :: Arg -> String

showList :: [Arg] -> ShowS

Eq Arg

Defined in OptEnvConf.Args

Methods

(==) :: Arg -> Arg -> Bool

(/=) :: Arg -> Arg -> Bool

Validity Arg

Defined in OptEnvConf.Args

Methods

validate :: Arg -> Validation

type Rep Arg

Defined in OptEnvConf.Args

type Rep Arg = D1 ('MetaData "Arg" "OptEnvConf.Args" "opt-env-conf-0.8.0.0-GWst156WP6fE4VnsM7jUpY" 'False) ((C1 ('MetaCons "ArgBareDoubleDash" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ArgBareDash" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ArgDashed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NonEmpty Char))) :+: C1 ('MetaCons "ArgPlain" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String))))

parseArg :: String -> Arg

renderArg :: Arg -> String

data Dashed

Constructors

DashedShort !Char

DashedLong !(NonEmpty Char)

Instances

IsString Dashed

Defined in OptEnvConf.Args

Methods

fromString :: String -> Dashed

Generic Dashed

Defined in OptEnvConf.Args

Associated Types

type Rep Dashed :: Type -> Type

Methods

from :: Dashed -> Rep Dashed x

to :: Rep Dashed x -> Dashed

Show Dashed

Defined in OptEnvConf.Args

Methods

showsPrec :: Int -> Dashed -> ShowS

show :: Dashed -> String

showList :: [Dashed] -> ShowS

Eq Dashed

Defined in OptEnvConf.Args

Methods

(==) :: Dashed -> Dashed -> Bool

(/=) :: Dashed -> Dashed -> Bool

Validity Dashed

Defined in OptEnvConf.Args

Methods

validate :: Dashed -> Validation

type Rep Dashed

Defined in OptEnvConf.Args

type Rep Dashed = D1 ('MetaData "Dashed" "OptEnvConf.Args" "opt-env-conf-0.8.0.0-GWst156WP6fE4VnsM7jUpY" 'False) (C1 ('MetaCons "DashedShort" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Char)) :+: C1 ('MetaCons "DashedLong" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NonEmpty Char))))

renderDashed :: Dashed -> String

prefixDashed :: String -> Dashed -> Dashed