Panfiguration

Documentation

data Panfiguration h

Instances

Monoid (Panfiguration h)

Defined in Panfiguration.Core

Methods

mempty :: Panfiguration h

mappend :: Panfiguration h -> Panfiguration h -> Panfiguration h

mconcat :: [Panfiguration h] -> Panfiguration h

Semigroup (Panfiguration h)

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

declCase :: Case -> Panfiguration h

Set the letter case of the data declaration

asCase :: Panfiguration h -> Case -> Panfiguration h

Set the letter case of the sources

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

Update names being used for the backends

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)

Provide all the default values by a plain record

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

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

Naming convention

data Case

Constructors

Delimiter String

AsIs

Camel

LowerCamel

Upper Case

Lower Case

Prefixed String Case

camel :: Case

snake :: Case

pattern SNAKE :: Case

pattern KEBAB :: Case

kebab :: Case

Parameter

class FromParam a

Instances

FromParam All

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String All

fromParamList :: String -> Either String [All]

mergeParams :: All -> All -> (Ordering, All)

FromParam Any

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String Any

fromParamList :: String -> Either String [Any]

mergeParams :: Any -> Any -> (Ordering, Any)

FromParam ByteString

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String ByteString

fromParamList :: String -> Either String [ByteString]

mergeParams :: ByteString -> ByteString -> (Ordering, ByteString)

FromParam PortNumber

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String PortNumber

fromParamList :: String -> Either String [PortNumber]

mergeParams :: PortNumber -> PortNumber -> (Ordering, PortNumber)

FromParam Text

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String Text

fromParamList :: String -> Either String [Text]

mergeParams :: Text -> Text -> (Ordering, Text)

FromParam Integer

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String Integer

fromParamList :: String -> Either String [Integer]

mergeParams :: Integer -> Integer -> (Ordering, Integer)

FromParam Natural

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String Natural

fromParamList :: String -> Either String [Natural]

mergeParams :: Natural -> Natural -> (Ordering, Natural)

FromParam ()

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String ()

fromParamList :: String -> Either String [()]

mergeParams :: () -> () -> (Ordering, ())

FromParam Bool

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String Bool

fromParamList :: String -> Either String [Bool]

mergeParams :: Bool -> Bool -> (Ordering, Bool)

FromParam Char

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String Char

fromParamList :: String -> Either String [Char]

mergeParams :: Char -> Char -> (Ordering, Char)

FromParam Double

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String Double

fromParamList :: String -> Either String [Double]

mergeParams :: Double -> Double -> (Ordering, Double)

FromParam Float

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String Float

fromParamList :: String -> Either String [Float]

mergeParams :: Float -> Float -> (Ordering, Float)

FromParam Int

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String Int

fromParamList :: String -> Either String [Int]

mergeParams :: Int -> Int -> (Ordering, Int)

FromParam a => FromParam (Identity a)

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String (Identity a)

fromParamList :: String -> Either String [Identity a]

mergeParams :: Identity a -> Identity a -> (Ordering, Identity a)

FromParam a => FromParam (Collect a)

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String (Collect a)

fromParamList :: String -> Either String [Collect a]

mergeParams :: Collect a -> Collect a -> (Ordering, Collect a)

(Typeable a, FromParam a) => FromParam (Secret a)

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String (Secret a)

fromParamList :: String -> Either String [Secret a]

mergeParams :: Secret a -> Secret a -> (Ordering, Secret a)

FromParam a => FromParam (Maybe a)

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String (Maybe a)

fromParamList :: String -> Either String [Maybe a]

mergeParams :: Maybe a -> Maybe a -> (Ordering, Maybe a)

FromParam a => FromParam [a]

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String [a]

fromParamList :: String -> Either String [[a]]

mergeParams :: [a] -> [a] -> (Ordering, [a])

FromParam a => FromParam (Const a b)

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String (Const a b)

fromParamList :: String -> Either String [Const a b]

mergeParams :: Const a b -> Const a b -> (Ordering, Const a b)

newtype Secret a

A newtype wrapper to distinguish confidential values. show and error messages from fromParam mask its contents.

Constructors

Secret

Fields

• unSecret :: a

Instances

Show a => Show (Secret a)

Defined in Panfiguration.FromParam

Methods

showsPrec :: Int -> Secret a -> ShowS

show :: Secret a -> String

showList :: [Secret a] -> ShowS

Eq a => Eq (Secret a)

Defined in Panfiguration.FromParam

Methods

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

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

Ord a => Ord (Secret a)

Defined in Panfiguration.FromParam

Methods

compare :: Secret a -> Secret a -> Ordering

(<) :: Secret a -> Secret a -> Bool

(<=) :: Secret a -> Secret a -> Bool

(>) :: Secret a -> Secret a -> Bool

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

max :: Secret a -> Secret a -> Secret a

min :: Secret a -> Secret a -> Secret a

(Typeable a, FromParam a) => FromParam (Secret a)

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String (Secret a)

fromParamList :: String -> Either String [Secret a]

mergeParams :: Secret a -> Secret a -> (Ordering, Secret a)

newtype Collect a

Collect all the specified parameters instead of overriding

Constructors

Collect

Fields

• unCollect :: [a]

Instances

Monoid (Collect a)

Defined in Panfiguration.FromParam

Methods

mempty :: Collect a

mappend :: Collect a -> Collect a -> Collect a

mconcat :: [Collect a] -> Collect a

Semigroup (Collect a)

Defined in Panfiguration.FromParam

Methods

(<>) :: Collect a -> Collect a -> Collect a

sconcat :: NonEmpty (Collect a) -> Collect a

stimes :: Integral b => b -> Collect a -> Collect a

Show a => Show (Collect a)

Defined in Panfiguration.FromParam

Methods

showsPrec :: Int -> Collect a -> ShowS

show :: Collect a -> String

showList :: [Collect a] -> ShowS

Eq a => Eq (Collect a)

Defined in Panfiguration.FromParam

Methods

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

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

Ord a => Ord (Collect a)

Defined in Panfiguration.FromParam

Methods

compare :: Collect a -> Collect a -> Ordering

(<) :: Collect a -> Collect a -> Bool

(<=) :: Collect a -> Collect a -> Bool

(>) :: Collect a -> Collect a -> Bool

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

max :: Collect a -> Collect a -> Collect a

min :: Collect a -> Collect a -> Collect a

FromParam a => FromParam (Collect a)

Defined in Panfiguration.FromParam

Methods

fromParam :: String -> Either String (Collect a)

fromParamList :: String -> Either String [Collect a]

mergeParams :: Collect a -> Collect a -> (Ordering, Collect a)