Copyright	(c) 2019 Lucas David Traverso
License	MPL-2.0
Maintainer	Lucas David Traverso <lucas6246@gmail.com>
Stability	stable
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Conferer.Source.CLIArgs

Description

Command line arguments based source

Synopsis

data CLIArgsSource = CLIArgsSource {
- originalCliArgs :: RawCLIArgs
- innerSource :: Source
}
type RawCLIArgs = [String]
fromConfig :: SourceCreator
fromEnv :: IO Source
fromArgs :: RawCLIArgs -> Source
parseArgsIntoKeyValue :: [String] -> [(Key, Text)]

Documentation

data CLIArgsSource Source #

This source provides keys from the command line arguments passed into the program. It only accepts arguments with -- and an equals, for example: ./awesomeapp --warp.port=5000

Constructors

CLIArgsSource
Fields originalCliArgs :: RawCLIArgs innerSource :: Source

Instances

Instances details

Show CLIArgsSource Source #
Instance details Defined in Conferer.Source.CLIArgs Methods showsPrec :: Int -> CLIArgsSource -> ShowS # show :: CLIArgsSource -> String # showList :: [CLIArgsSource] -> ShowS #
IsSource CLIArgsSource Source #
Instance details Defined in Conferer.Source.CLIArgs Methods getKeyInSource :: CLIArgsSource -> Key -> IO (Maybe Text) Source # getSubkeysInSource :: CLIArgsSource -> Key -> IO [Key] Source #

type RawCLIArgs = [String] Source #

Type alias for cli args

fromConfig :: SourceCreator Source #

Create a SourceCreator using fromEnv

fromEnv :: IO Source Source #

Create a Source using fromArgs but using real cli args

fromArgs :: RawCLIArgs -> Source Source #

Create a Source using cli args passed as parameter

parseArgsIntoKeyValue :: [String] -> [(Key, Text)] Source #

Parse an argument list into a dictionary suitable for a Source