Toml.Bi.Map

Implementation of tagged partial bidirectional isomorphism.

BiMap idea

data BiMap e a b

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:

Constructors

BiMap

Fields

• forward :: a -> Either e b
• backward :: b -> Either e a

Instances

Category (BiMap e :: Type -> Type -> Type)

Defined in Toml.Bi.Map

Methods

id :: forall (a :: k). BiMap e a a

(.) :: forall (b :: k) (c :: k) (a :: k). BiMap e b c -> BiMap e a b -> BiMap e a c

type TomlBiMap = BiMap TomlBiMapError

BiMap specialized to TOML error.

invert :: BiMap e a b -> BiMap e b a

Inverts bidirectional mapping.

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

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

prism :: (field -> object) -> (object -> Either error field) -> BiMap error object field

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

BiMap errors for TOML

data TomlBiMapError

Type of errors for TOML BiMap.

Constructors

WrongConstructor

Error for cases with wrong constructors. For example, you're trying to convert Left but bidirectional converter expects Right.

Fields

• !Text

  Expected constructor name

• !Text

  Actual value

WrongValue

Error for cases with wrong values

Fields

• !MatchError

  Information about failed matching

ArbitraryError

Arbitrary textual error

Fields

• !Text

  Error message

Instances

Eq TomlBiMapError

Defined in Toml.Bi.Map

Methods

(==) :: TomlBiMapError -> TomlBiMapError -> Bool

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

Show TomlBiMapError

Defined in Toml.Bi.Map

Methods

showsPrec :: Int -> TomlBiMapError -> ShowS

show :: TomlBiMapError -> String

showList :: [TomlBiMapError] -> ShowS

Generic TomlBiMapError

Defined in Toml.Bi.Map

Associated Types

type Rep TomlBiMapError :: Type -> Type

Methods

from :: TomlBiMapError -> Rep TomlBiMapError x

to :: Rep TomlBiMapError x -> TomlBiMapError

NFData TomlBiMapError

Defined in Toml.Bi.Map

Methods

rnf :: TomlBiMapError -> ()

type Rep TomlBiMapError

Defined in Toml.Bi.Map

type Rep TomlBiMapError = D1 ('MetaData "TomlBiMapError" "Toml.Bi.Map" "tomland-1.2.1.0-inplace" 'False) (C1 ('MetaCons "WrongConstructor" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :+: (C1 ('MetaCons "WrongValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MatchError)) :+: C1 ('MetaCons "ArbitraryError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text))))

wrongConstructor

Arguments

:: Show a

=> Text

Name of the expected constructor

-> a

Actual value

-> Either TomlBiMapError b

Helper to construct WrongConstuctor error.

prettyBiMapError :: TomlBiMapError -> Text

Converts TomlBiMapError into pretty human-readable text.

Some predefined bi mappings

_Array :: forall a. TomlBiMap a AnyValue -> TomlBiMap [a] AnyValue

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 :: TomlBiMap Bool AnyValue

Bool bimap for AnyValue. Usually used as bool combinator.

_Double :: TomlBiMap Double AnyValue

Double bimap for AnyValue. Usually used as double combinator.

_Integer :: TomlBiMap Integer AnyValue

Integer bimap for AnyValue. Usually used as integer combinator.

_Text :: TomlBiMap Text AnyValue

Text bimap for AnyValue. Usually used as text combinator.

_LText :: TomlBiMap Text AnyValue

Text bimap for AnyValue. Usually used as lazyText combinator.

_ZonedTime :: TomlBiMap ZonedTime AnyValue

ZonedTime bimap for AnyValue. Usually used as zonedTime combinator.

_LocalTime :: TomlBiMap LocalTime AnyValue

LocalTime bimap for AnyValue. Usually used as localTime combinator.

_Day :: TomlBiMap Day AnyValue

Day bimap for AnyValue. Usually used as day combinator.

_TimeOfDay :: TomlBiMap TimeOfDay AnyValue

TimeOfDay bimap for AnyValue. Usually used as timeOfDay combinator.

_String :: TomlBiMap String AnyValue

String bimap for AnyValue. Usually used as string combinator.

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

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

_Natural :: TomlBiMap Natural AnyValue

String bimap for AnyValue. Usually used as natural combinator.

_Word :: TomlBiMap Word AnyValue

Word bimap for AnyValue. Usually used as word combinator.

_Word8 :: TomlBiMap Word8 AnyValue

Word8 bimap for AnyValue. Usually used as word8 combinator.

Since: 1.2.0.0

_Int :: TomlBiMap Int AnyValue

Int bimap for AnyValue. Usually used as int combinator.

_Float :: TomlBiMap Float AnyValue

Float bimap for AnyValue. Usually used as float combinator.

_ByteString :: TomlBiMap ByteString AnyValue

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

_LByteString :: TomlBiMap ByteString AnyValue

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

_ByteStringArray :: TomlBiMap ByteString AnyValue

ByteString bimap for AnyValue encoded as a list of non-negative integers. Usually used as byteStringArray combinator.

Since: 1.2.0.0

_LByteStringArray :: TomlBiMap ByteString AnyValue

Lazy ByteString bimap for AnyValue encoded as a list of non-negative integers. Usually used as lazyByteStringArray combinator.

Since: 1.2.0.0

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

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.

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

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 :: TomlBiMap IntSet AnyValue

IntSet bimap for AnyValue. Usually used as arrayIntSet combinator.

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

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.

Helpers for BiMap and AnyValue

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

Creates prism for AnyValue.

_TextBy

Arguments

:: forall a. (a -> Text)

show function for a

-> (Text -> Either Text a)

Parser of a from Text

-> TomlBiMap a AnyValue

Creates bimap for Text to AnyValue with custom functions

_LTextText :: BiMap e Text Text

Helper bimap for Text and Text.

_NaturalInteger :: TomlBiMap Natural Integer

Helper bimap for Natural and Integer.

_StringText :: BiMap e String Text

Helper bimap for String and Text.

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

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

_BoundedInteger :: (Integral a, Bounded a, Show a) => TomlBiMap a Integer

Helper bimap for Integer and integral, bounded values.

_EnumBoundedText :: forall a. (Show a, Enum a, Bounded a) => TomlBiMap a Text

Helper bimap for _EnumBounded and Text.

Since: 1.1.1.0

_ByteStringText :: TomlBiMap ByteString Text

Helper bimap for Text and strict ByteString

_LByteStringText :: TomlBiMap ByteString Text

Helper bimap for Text and lazy ByteString.

_Left :: (Show l, Show r) => TomlBiMap (Either l r) l

Bimap for Either and its left type

_Right :: (Show l, Show r) => TomlBiMap (Either l r) r

Bimap for Either and its right type

_EnumBounded :: (Show a, Enum a, Bounded a) => TomlBiMap a AnyValue

Bimap for nullary sum data types with Show, Enum and Bounded instances. Usually used as enumBounded combinator.

Since: 1.1.1.0

_Just :: Show r => TomlBiMap (Maybe r) r

Bimap for Maybe

Useful utility functions

toMArray :: [AnyValue] -> Either MatchError (Value 'TArray)

Function for creating Array from list of AnyValue.