Partial bidirectional isomorphism. BiMap a b contains two function:

1. a -> Either e b

2. 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 specialized to TOML error.

Inverts bidirectional mapping.

Creates BiMap from isomorphism. Can be used in the following way:

newtype Even = Even Integer
newtype Odd  = Odd  Integer

succEven :: Even -> Odd
succEven (Even n) = Odd (n + 1)

predOdd :: Odd -> Even
predOdd (Odd n) = Even (n - 1)

_EvenOdd :: BiMap e Even Odd
_EvenOdd = iso succEven predOdd

Creates BiMap from prism-like pair of functions. This combinator can be used to create BiMap for custom data types like this:

data User
    = Admin  Integer  -- id of admin
    | Client Text     -- name of the client
    deriving (Show)

_Admin :: TomlBiMap User Integer
_Admin = Toml.prism Admin $ \case
    Admin i -> Right i
    other   -> Toml.wrongConstructor "Admin" other

_Client :: TomlBiMap User Text
_Client = Toml.prism Client $ \case
    Client n -> Right n
    other    -> Toml.wrongConstructor "Client" other

Type of errors for TOML BiMap.

Helper to construct WrongConstuctor error.

Converts TomlBiMapError into pretty human-readable text.

Creates prism for AnyValue.

Creates bimap for Text to AnyValue with custom functions

Helper bimap for Text and Text.

Helper bimap for Natural and Integer.

Helper bimap for String and Text.

Helper bimap for String and types with Read and Show instances.

Helper bimap for Integer and integral, bounded values.

Helper bimap for Text and strict ByteString

Helper bimap for Text and lazy ByteString.

Takes a bimap of a value and returns a bimap between a list of values and AnyValue as an array. Usually used as arrayOf combinator.

Bool bimap for AnyValue. Usually used as bool combinator.

Double bimap for AnyValue. Usually used as double combinator.

Integer bimap for AnyValue. Usually used as integer combinator.

Text bimap for AnyValue. Usually used as text combinator.

Text bimap for AnyValue. Usually used as lazyText combinator.

ZonedTime bimap for AnyValue. Usually used as zonedTime combinator.

LocalTime bimap for AnyValue. Usually used as localTime combinator.

Day bimap for AnyValue. Usually used as day combinator.

TimeOfDay bimap for AnyValue. Usually used as timeOfDay combinator.

String bimap for AnyValue. Usually used as string combinator.

Bimap for AnyValue and values with a Read and Show instance. Usually used as read combinator.

String bimap for AnyValue. Usually used as natural combinator.

Word bimap for AnyValue. Usually used as word combinator.

Int bimap for AnyValue. Usually used as int combinator.

Float bimap for AnyValue. Usually used as float combinator.

UTF8 encoded ByteString bimap for AnyValue. Usually used as byteString combinator.

UTF8 encoded lazy ByteString bimap for AnyValue. Usually used as lazyByteString combinator.

Takes a bimap of a value and returns a bimap between a set of values and AnyValue as an array. Usually used as arraySetOf combinator.

IntSet bimap for AnyValue. Usually used as arrayIntSetOf combinator.

Takes a bimap of a value and returns a bimap between a hash set of values and AnyValue as an array. Usually used as arrayHashSetOf combinator.

Takes a bimap of a value and returns a bimap between a non-empty list of values and AnyValue as an array. Usually used as nonEmpty combinator.

Bimap for Either and its left type

Bimap for Either and its right type

Bimap for Maybe

Function for creating Array from list of AnyValue.