Toml.Type

Contains specification of TOML via Haskell ADT.

Main type

data TOML

Represents TOML configuration value.

Constructors

TOML

Fields

• tomlPairs :: HashMap Key AnyValue
• tomlTables :: PrefixMap TOML

Instances

Eq TOML

Methods

(==) :: TOML -> TOML -> Bool

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

Show TOML

Methods

showsPrec :: Int -> TOML -> ShowS

show :: TOML -> String

showList :: [TOML] -> ShowS

Values

data ValueType

Needed for GADT parameterization

Constructors

TBool

TInt

TFloat

TString

TDate

TArray

Instances

Eq ValueType

Methods

(==) :: ValueType -> ValueType -> Bool

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

Show ValueType

Methods

showsPrec :: Int -> ValueType -> ShowS

show :: ValueType -> String

showList :: [ValueType] -> ShowS

data Value (t :: ValueType) where

Value in key = value pair.

Constructors

Bool :: Bool -> Value TBool

Boolean value:

bool1 = true
bool2 = false

Int :: Integer -> Value TInt

Integer value:

int1 = +99
int2 = 42
int3 = 0
int4 = -17
int5 = 5_349_221
hex1 = 0xDEADBEEF
oct2 = 0o755 # useful for Unix file permissions
bin1 = 0b11010110

Float :: Double -> Value TFloat

Floating point number:

flt1 = -3.1415   # fractional
flt2 = 1e6       # exponent
flt3 = 6.626e-34 # both
flt4 = 9_224_617.445_991_228_313

String :: Text -> Value TString

String value:

key = "value"
bare_key = "value"
bare-key = "value"

Date :: DateTime -> Value TDate

Date-time. See documentation for DateTime type.

Array :: [Value t] -> Value TArray

Array of values. According to TOML specification all values in array should have the same type. This is guaranteed statically with this type.

arr1 = [ 1, 2, 3 ]
arr2 = [ "red", "yellow", "green" ]
arr3 = [ [ 1, 2 ], [3, 4, 5] ]
arr4 = [ "all", strings, """are the same""", ''type'']
arr5 = [ [ 1, 2 ], ["a", "b", "c"] ]

arr6 = [ 1, 2.0 ] # INVALID

Instances

Eq (Value t)

Methods

(==) :: Value t -> Value t -> Bool

(/=) :: Value t -> Value t -> Bool

Show (Value t)

Methods

showsPrec :: Int -> Value t -> ShowS

show :: Value t -> String

showList :: [Value t] -> ShowS

data AnyValue

Existential wrapper for Value.

Constructors

AnyValue (Value t)

Instances

Eq AnyValue

Methods

(==) :: AnyValue -> AnyValue -> Bool

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

Show AnyValue

Methods

showsPrec :: Int -> AnyValue -> ShowS

show :: AnyValue -> String

showList :: [AnyValue] -> ShowS

data UValue

Untyped value of TOML. You shouldn't use this type in your code. Use Value instead.

Constructors

UBool !Bool

UInt !Integer

UFloat !Double

UString !Text

UDate !DateTime

UArray ![UValue]

data DateTime

Constructors

Zoned !ZonedTime

Offset date-time:

odt1 = 1979-05-27T07:32:00Z
odt2 = 1979-05-27T00:32:00-07:00

Local !LocalTime

Local date-time (without offset):

ldt1 = 1979-05-27T07:32:00
ldt2 = 1979-05-27T00:32:00.999999

Day !Day

Local date (only day):

ld1 = 1979-05-27

Hours !TimeOfDay

Local time (time of the day):

lt1 = 07:32:00
lt2 = 00:32:00.999999

Instances

Eq DateTime

Methods

(==) :: DateTime -> DateTime -> Bool

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

Show DateTime

Methods

showsPrec :: Int -> DateTime -> ShowS

show :: DateTime -> String

showList :: [DateTime] -> ShowS

matchBool :: Value f -> Maybe Bool

Extract Bool from Value.

matchInteger :: Value f -> Maybe Integer

Extract Integer from Value.

matchDouble :: Value f -> Maybe Double

Extract Double from Value.

matchText :: Value f -> Maybe Text

Extract Text from Value.

matchDate :: Value f -> Maybe DateTime

Extract DateTime from Value.

matchArray :: (forall t. Value t -> Maybe a) -> Value f -> Maybe [a]

Extract list of elements of type a from array.

valueType :: Value t -> ValueType

Reifies type of Value into ValueType. Unfortunately, there's no way to guarante that valueType will return t for object with type Value 't.

Internal functions

typeCheck :: UValue -> Either TypeMismatchError AnyValue

Ensures that UValues represents type-safe version of toml.