panfiguration-0.0: Merge environment variables and command line options generically

Safe Haskell	Safe-Inferred
Language	Haskell2010

Panfiguration.Core

Synopsis

data Panfiguration h = Panfiguration {
- fieldNameCase :: First Case
- loggerFunction :: First (String -> IO ())
- sources :: [Source h]
}
data Result a = Result {
- resultSources :: [String]
- resultUsed :: [String]
- resultContent :: Maybe a
}
data Source h = Source {
- sourceCase :: Case
- sourceRun :: h (Const String) -> IO (h Result)
}
declCase :: Case -> Panfiguration h
asCase :: Panfiguration h -> Case -> Panfiguration h
withNames :: Panfiguration h -> (h (Const String) -> h (Const String)) -> Panfiguration h
envs :: (TraversableB h, ConstraintsB h, AllB FromParam h) => Panfiguration h
opts :: (TraversableB h, ConstraintsB h, AllB FromParam h) => Panfiguration h
defaults :: FunctorB h => h Maybe -> Panfiguration h
fullDefaults :: (BareB b, FunctorB (b Covered)) => b Bare Identity -> Panfiguration (b Covered)
logger :: (String -> IO ()) -> Panfiguration h
type Panfigurable h = (FieldNamesB h, TraversableB h, ApplicativeB h, ConstraintsB h, AllB Show h, AllB FromParam h)
exec :: Panfigurable h => Panfiguration h -> IO (h Result)
run :: (BareB b, Panfigurable (b Covered)) => Panfiguration (b Covered) -> IO (b Bare Identity)
runMaybe :: Panfigurable h => Panfiguration h -> IO (h Maybe)

Documentation

data Panfiguration h Source #

Constructors

Panfiguration
Fields fieldNameCase :: First Case loggerFunction :: First (String -> IO ()) sources :: [Source h]

Instances

Instances details

Monoid (Panfiguration h) Source #
Instance details Defined in Panfiguration.Core Methods mempty :: Panfiguration h # mappend :: Panfiguration h -> Panfiguration h -> Panfiguration h # mconcat :: [Panfiguration h] -> Panfiguration h #
Semigroup (Panfiguration h) Source #
Instance details Defined in Panfiguration.Core Methods (<>) :: Panfiguration h -> Panfiguration h -> Panfiguration h # sconcat :: NonEmpty (Panfiguration h) -> Panfiguration h # stimes :: Integral b => b -> Panfiguration h -> Panfiguration h #

data Result a Source #

Constructors

Result
Fields resultSources :: [String] resultUsed :: [String] resultContent :: Maybe a

Instances

Instances details

FromParam a => Monoid (Result a) Source #
Instance details Defined in Panfiguration.Core Methods mempty :: Result a # mappend :: Result a -> Result a -> Result a # mconcat :: [Result a] -> Result a #
FromParam a => Semigroup (Result a) Source #
Instance details Defined in Panfiguration.Core Methods (<>) :: Result a -> Result a -> Result a # sconcat :: NonEmpty (Result a) -> Result a # stimes :: Integral b => b -> Result a -> Result a #
Show a => Show (Result a) Source #
Instance details Defined in Panfiguration.Core Methods showsPrec :: Int -> Result a -> ShowS # show :: Result a -> String # showList :: [Result a] -> ShowS #
Eq a => Eq (Result a) Source #
Instance details Defined in Panfiguration.Core Methods (==) :: Result a -> Result a -> Bool # (/=) :: Result a -> Result a -> Bool #
Ord a => Ord (Result a) Source #
Instance details Defined in Panfiguration.Core Methods compare :: Result a -> Result a -> Ordering # (<) :: Result a -> Result a -> Bool # (<=) :: Result a -> Result a -> Bool # (>) :: Result a -> Result a -> Bool # (>=) :: Result a -> Result a -> Bool # max :: Result a -> Result a -> Result a # min :: Result a -> Result a -> Result a #

data Source h Source #

Constructors

Source
Fields sourceCase :: Case sourceRun :: h (Const String) -> IO (h Result)

declCase :: Case -> Panfiguration h Source #

Set the letter case of the data declaration

asCase :: Panfiguration h -> Case -> Panfiguration h Source #

Set the letter case of the sources

withNames :: Panfiguration h -> (h (Const String) -> h (Const String)) -> Panfiguration h Source #

Update names being used for the backends

envs :: (TraversableB h, ConstraintsB h, AllB FromParam h) => Panfiguration h Source #

opts :: (TraversableB h, ConstraintsB h, AllB FromParam h) => Panfiguration h Source #

defaults :: FunctorB h => h Maybe -> Panfiguration h Source #

fullDefaults :: (BareB b, FunctorB (b Covered)) => b Bare Identity -> Panfiguration (b Covered) Source #

Provide all the default values by a plain record

logger :: (String -> IO ()) -> Panfiguration h Source #

type Panfigurable h = (FieldNamesB h, TraversableB h, ApplicativeB h, ConstraintsB h, AllB Show h, AllB FromParam h) Source #

exec :: Panfigurable h => Panfiguration h -> IO (h Result) Source #

Parse all the relevant environment variables and command line options, then merges them.

run :: (BareB b, Panfigurable (b Covered)) => Panfiguration (b Covered) -> IO (b Bare Identity) Source #

runMaybe :: Panfigurable h => Panfiguration h -> IO (h Maybe) Source #