Toml.BiMap

Implementation of partial bidirectional mapping as a data type.

BiMap idea

data BiMap a b

Partial bidirectional isomorphism. BiMap a b contains two function:

1. a -> Maybe b

2. b -> Maybe a

Constructors

BiMap

Fields

• forward :: a -> Maybe b
• backward :: b -> Maybe a

Instances

Category BiMap

Defined in Toml.BiMap

Methods

id :: BiMap a a

(.) :: BiMap b c -> BiMap a b -> BiMap a c

invert :: BiMap a b -> BiMap b a

Inverts bidirectional mapping.

iso :: (a -> b) -> (b -> a) -> BiMap a b

Creates BiMap from isomorphism.

prism :: (field -> object) -> (object -> Maybe field) -> BiMap object field

Creates BiMap from prism-like pair of functions.

Helpers for BiMap and AnyValue

mkAnyValueBiMap :: (forall t. Value t -> Maybe a) -> (a -> Value tag) -> BiMap a AnyValue

Creates prism for AnyValue.

_TextBy :: (a -> Text) -> (Text -> Maybe a) -> BiMap a AnyValue

Creates bimap for Value to AnyValue with custom functions

_NaturalInteger :: BiMap Natural Integer

Helper bimap for Natural and Value.

_StringText :: BiMap String Text

Helper bimap for String and Value.

_ReadString :: (Show a, Read a) => BiMap a String

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

_BoundedInteger :: (Integral a, Bounded a) => BiMap a Integer

Helper bimap for Value and integral, bounded values.

_ByteStringText :: BiMap ByteString Text

Helper bimap for Value and strict ByteString

_LByteStringText :: BiMap ByteString Text

Helper bimap for Value and lazy ByteString

Some predefined bi mappings

_Array :: BiMap a AnyValue -> BiMap [a] AnyValue

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

_Bool :: BiMap Bool AnyValue

Value bimap for AnyValue. Usually used with bool combinator.

_Double :: BiMap Double AnyValue

Value bimap for AnyValue. Usually used with double combinator.

_Integer :: BiMap Integer AnyValue

Value bimap for AnyValue. Usually used with integer combinator.

_Text :: BiMap Text AnyValue

Value bimap for AnyValue. Usually used with text combinator.

_ZonedTime :: BiMap ZonedTime AnyValue

Zoned time bimap for AnyValue. Usually used with zonedTime combinator.

_LocalTime :: BiMap LocalTime AnyValue

Local time bimap for AnyValue. Usually used with localTime combinator.

_Day :: BiMap Day AnyValue

Day bimap for AnyValue. Usually used with day combinator.

_TimeOfDay :: BiMap TimeOfDay AnyValue

Time of day bimap for AnyValue. Usually used with timeOfDay combinator.

_String :: BiMap String AnyValue

String bimap for AnyValue. Usually used with string combinator.

_Read :: (Show a, Read a) => BiMap a AnyValue

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

_Natural :: BiMap Natural AnyValue

Natural bimap for AnyValue. Usually used with natural combinator.

_Word :: BiMap Word AnyValue

Word bimap for AnyValue. Usually used with word combinator.

_Int :: BiMap Int AnyValue

Int bimap for AnyValue. Usually used with int combinator.

_Float :: BiMap Float AnyValue

Float bimap for AnyValue. Usually used with float combinator.

_ByteString :: BiMap ByteString AnyValue

ByteString bimap for AnyValue. Usually used with byteString combinator.

_LByteString :: BiMap ByteString AnyValue

Lazy ByteString bimap for AnyValue. Usually used with lazyByteString combinator.

_Set :: Ord a => BiMap a AnyValue -> BiMap (Set a) AnyValue

Takes a bimap of a value and returns a bimap of a set of values and Anything as an array. Usually used with setOf combinator.

_IntSet :: BiMap IntSet AnyValue

Bimap of IntSet and Anything as an array. Usually used with intSet combinator.

_HashSet :: (Eq a, Hashable a) => BiMap a AnyValue -> BiMap (HashSet a) AnyValue

Takes a bimap of a value and returns a bimap of a has set of values and Anything as an array. Usually used with hashSetOf combinator.

_NonEmpty :: BiMap a AnyValue -> BiMap (NonEmpty a) AnyValue

Takes a bimap of a value and returns a bimap of a non-empty list of values and Anything as an array. Usually used with nonEmptyOf combinator.

_Left :: BiMap (Either l r) l

Bimap for Either and its left type

_Right :: BiMap (Either l r) r

Bimap for Either and its right type

_Just :: BiMap (Maybe a) a

Bimap for Maybe

Useful utility functions

toMArray :: [AnyValue] -> Maybe (Value TArray)

Function for creating Array from list of AnyValue.