Toml.Bi.Combinators

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

Types

type BiToml a = Bi Env St a

Specialied Bi type alias for Toml monad. Keeps TOML object either as environment or state.

type Env = ExceptT EncodeException (Reader TOML)

Immutable environment for Toml conversion. This is r type variable in Bijection data type.

type St = ExceptT DecodeException (State TOML)

Mutable context for Toml conversion. This is w type variable in Bijection data type.

Exceptions

data EncodeException

Type of exception for converting from Toml to user custom data type.

Instances

Eq EncodeException

Methods

(==) :: EncodeException -> EncodeException -> Bool

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

Show EncodeException

Methods

showsPrec :: Int -> EncodeException -> ShowS

show :: EncodeException -> String

showList :: [EncodeException] -> ShowS

data DecodeException

Write exception for convertion to Toml from user custom data type.

Instances

Eq DecodeException

Methods

(==) :: DecodeException -> DecodeException -> Bool

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

Show DecodeException

Methods

showsPrec :: Int -> DecodeException -> ShowS

show :: DecodeException -> String

showList :: [DecodeException] -> ShowS

Encode/Decode

encode :: BiToml a -> Text -> Either EncodeException a

Convert textual representation of toml into user data type.

decode :: BiToml a -> a -> Either DecodeException Text

Convert object to textual representation.

unsafeDecode :: BiToml a -> a -> Text

Unsafe version of decode function if you're sure that you decoding of structure is correct.

Converters

bijectionMaker

Arguments

:: Text

Name of expected type

-> (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.

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.

str :: Key -> BiToml Text

Parser for string values.

arrayOf :: forall a t. Valuer t a -> Key -> BiToml [a]

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

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

Bidirectional converter for Maybe smth values.

Value parsers

data Valuer (tag :: ValueType) a

This data type describes how to convert value of type a into and from Value.

Constructors

Valuer

Fields

• valFrom :: forall t. Value t -> Maybe a
• valTo :: a -> Value tag

boolV :: Valuer TBool Bool

Bool parser for array element. Use with arrayOf parser.

integerV :: Valuer TInt Integer

Int parser for array element. Use with arrayOf parser.

doubleV :: Valuer TFloat Double

Double parser for array element. Use with arrayOf parser.

strV :: Valuer TString Text

Text parser for array element. Use with arrayOf parser.

arrV :: forall a t. Valuer t a -> Valuer TArray [a]

Parser for array element which is an array itself. Use with arrayOf parser.