bimap package:tomland

Implementation of Tagged Partial Bidirectional Isomorphism. This module contains the BiMap type that represents conversion between two types with the possibility of failure. See Toml.Codec.BiMap.Conversion for examples of BiMap with specific types. The BiMap concept is general and is not specific to TOML, but in this package most usages of BiMap are between TOML values and Haskell values.

data BiMap e a b

tomland Toml.Codec.BiMap

Partial bidirectional isomorphism. BiMap a b contains two function:

```
a -> Either e b
```
```
b -> Either e a
```

If you think of types as sets then this data type can be illustrated by the following picture: BiMap also implements Category typeclass. And this instance can be described clearly by this illustration:

BiMap :: (a -> Either e b) -> (b -> Either e a) -> BiMap e a b

tomland Toml.Codec.BiMap

BiMapError :: Key -> TomlBiMapError -> TomlDecodeError

tomland Toml.Codec.Error

type TomlBiMap = BiMap TomlBiMapError

tomland Toml.Codec.BiMap

BiMap specialized to TOML error.

data TomlBiMapError

tomland Toml.Codec.BiMap

Type of errors for TOML BiMap.

mkAnyValueBiMap :: forall a (tag :: TValue) . (forall (t :: TValue) . Value t -> Either MatchError a) -> (a -> Value tag) -> TomlBiMap a AnyValue

tomland Toml.Codec.BiMap

Smart constructor for BiMap from a Haskell value (some primitive like Int or Value) to AnyValue.

prettyBiMapError :: TomlBiMapError -> Text

tomland Toml.Codec.BiMap

Converts TomlBiMapError into pretty human-readable text.

whenLeftBiMapError :: Key -> Either TomlBiMapError a -> (a -> Validation [TomlDecodeError] b) -> Validation [TomlDecodeError] b

tomland Toml.Codec.Combinator.Common

Throw error on Left, or perform a given action with Right.