| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Toml.Bi.Combinators
Description
Contains TOML-specific combinators for converting between TOML and user data types.
- type BiToml a = Bi Env St a
- type Env = ExceptT EncodeException (Reader TOML)
- type St = ExceptT DecodeException (State TOML)
- data EncodeException
- data DecodeException
- encode :: BiToml a -> Text -> Either EncodeException a
- decode :: BiToml a -> a -> Either DecodeException Text
- unsafeDecode :: BiToml a -> a -> Text
- bijectionMaker :: forall a t. Text -> (forall f. Value f -> Maybe a) -> (a -> Value t) -> Key -> BiToml a
- bool :: Key -> BiToml Bool
- int :: Key -> BiToml Int
- double :: Key -> BiToml Double
- str :: Key -> BiToml Text
Types
type Env = ExceptT EncodeException (Reader TOML) Source #
Immutable environment for Toml conversion.
This is r type variable in Bijection data type.
type St = ExceptT DecodeException (State TOML) Source #
Mutable context for Toml conversion.
This is w type variable in Bijection data type.
Exceptions
data EncodeException Source #
Type of exception for converting from Toml to user custom data type.
Instances
data DecodeException Source #
Write exception for convertion to Toml from user custom data type.
Instances
Encode/Decode
encode :: BiToml a -> Text -> Either EncodeException a Source #
Convert textual representation of toml into user data type.
decode :: BiToml a -> a -> Either DecodeException Text Source #
Convert object to textual representation.
unsafeDecode :: BiToml a -> a -> Text Source #
Unsafe version of decode function if you're sure that you decoding
of structure is correct.