Toml.Bi.Combinators

Contains TOML-specific combinators for converting between TOML and user data types.

Converters

bijectionMaker

Arguments

:: Typeable a

=> (forall f. Value f -> Maybe a)

How to convert from AnyValue to a

-> (a -> Value t)

Convert a to Anyvale

-> Key

Key of the value

-> BiToml a

General function to create bidirectional converters for values.

dimapNum :: forall n r w. (Integral n, Functor r, Functor w) => Bi r w Integer -> Bi r w n

Helper dimapper to turn integer parser into parser for Int, Natural, Word, etc.

mdimap

Arguments

:: (Monad r, Monad w, MonadError DecodeException r)

=> (c -> d)

Convert from safe to unsafe value

-> (a -> Maybe b)

Parser for more type safe value

-> Bijection r w d a

Source Bijection object

-> Bijection r w c b

Almost same as dimap. Useful when you want to have fields like this inside your configuration:

data GhcVer = Ghc7103 | Ghc802 | Ghc822 | Ghc842

showGhcVer  :: GhcVer -> Text
parseGhcVer :: Text -> Maybe GhcVer

When you specify couple of functions of the following types:

show  :: a -> Text
parse :: Text -> Maybe a

they should satisfy property parse . show == Just if you want to use your converter for pretty-printing.

Toml parsers

bool :: Key -> BiToml Bool

Parser for boolean values.

int :: Key -> BiToml Int

Parser for integer values.

integer :: Key -> BiToml Integer

Parser for integer values.

double :: Key -> BiToml Double

Parser for floating values.

text :: Key -> BiToml Text

Parser for string values.

arrayOf :: forall a. Typeable a => Prism AnyValue a -> Key -> BiToml [a]

Parser for array of values. Takes converter for single array element and returns list of values.

maybeT :: forall a. (Key -> BiToml a) -> Key -> BiToml (Maybe a)

Bidirectional converter for Maybe smth values.

table :: forall a. BiToml a -> Key -> BiToml a

Parser for tables. Use it when when you have nested objects.

wrapper :: forall b a. Coercible a b => (Key -> BiToml a) -> Key -> BiToml b

Used for newtype wrappers.