tomland-0.2.1: TOML parser

Safe HaskellNone
LanguageHaskell2010

Toml.Type

Contents

Description

Contains specification of TOML via Haskell ADT.

Synopsis

Main type

data TOML Source #

Represents TOML configuration value.

Instances

Eq TOML Source # 

Methods

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

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

Show TOML Source # 

Methods

showsPrec :: Int -> TOML -> ShowS #

show :: TOML -> String #

showList :: [TOML] -> ShowS #

Values

data ValueType Source #

Needed for GADT parameterization

Constructors

TBool 
TInt 
TFloat 
TString 
TDate 
TArray 

data Value (t :: ValueType) where Source #

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) Source # 

Methods

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

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

Show (Value t) Source # 

Methods

showsPrec :: Int -> Value t -> ShowS #

show :: Value t -> String #

showList :: [Value t] -> ShowS #

data AnyValue Source #

Existential wrapper for Value.

Constructors

AnyValue (Value t) 

data UValue Source #

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

data DateTime Source #

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

matchBool :: Value f -> Maybe Bool Source #

Extract Bool from Value.

matchText :: Value f -> Maybe Text Source #

Extract Text from Value.

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

Extract list of elements of type a from array.

valueType :: Value t -> ValueType Source #

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 Source #

Ensures that UValues represents type-safe version of toml.