TOML

Parser for the TOML file format: https://github.com/toml-lang/toml

Parsing

parseTOML :: Text -> Either TOMLError [(Text, Value)]

Parse the given TOML file. Returns the top-level table as a list of key-value pairs or returns an error.

Values

data Value

Values possible in a TOML file

Constructors

Table [(Text, Value)]

table, key-value pairs

List [Value]

array

Double !Double

floating-point literal

Integer !Integer

integer literal

String !Text

string literal

Bool Bool

boolean literal

ZonedTimeV !ZonedTime

offset date-time

LocalTimeV !LocalTime

local date-time

DayV !Day

local date

TimeOfDayV !TimeOfDay

local time

Instances

Read Value

Methods

readsPrec :: Int -> ReadS Value

readList :: ReadS [Value]

readPrec :: ReadPrec Value

readListPrec :: ReadPrec [Value]

Show Value

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

Error information

data TOMLError

Errors that can occur while loading a TOML file.

Constructors

Unexpected (Located Token)

unexpected token while parser

Unterminated (Located Token)

unterminated token while parser

OverlappingKey [Text]

ambiguous table entry

Instances

Read TOMLError

Methods

readsPrec :: Int -> ReadS TOMLError

readList :: ReadS [TOMLError]

readPrec :: ReadPrec TOMLError

readListPrec :: ReadPrec [TOMLError]

Show TOMLError

Methods

showsPrec :: Int -> TOMLError -> ShowS

show :: TOMLError -> String

showList :: [TOMLError] -> ShowS

Exception TOMLError

displayException provides human-readable error message

Methods

toException :: TOMLError -> SomeException

fromException :: SomeException -> Maybe TOMLError

displayException :: TOMLError -> String

data LexerError

Errors possible in the course of lexing

Constructors

UntermString

unterminated string literal

BadEscape

invalid escape sequence

NoMatch Char

no matching lexer rule

Instances

Read LexerError

Methods

readsPrec :: Int -> ReadS LexerError

readList :: ReadS [LexerError]

readPrec :: ReadPrec LexerError

readListPrec :: ReadPrec [LexerError]

Show LexerError

Methods

showsPrec :: Int -> LexerError -> ShowS

show :: LexerError -> String

showList :: [LexerError] -> ShowS

data Located a

A value annotated with its text file position

Constructors

Located

Fields

• locPosition :: !Position

  position information

• locThing :: !a

  annotated value

Instances

Functor Located

Methods

fmap :: (a -> b) -> Located a -> Located b

(<$) :: a -> Located b -> Located a

Foldable Located

Methods

fold :: Monoid m => Located m -> m

foldMap :: Monoid m => (a -> m) -> Located a -> m

foldr :: (a -> b -> b) -> b -> Located a -> b

foldr' :: (a -> b -> b) -> b -> Located a -> b

foldl :: (b -> a -> b) -> b -> Located a -> b

foldl' :: (b -> a -> b) -> b -> Located a -> b

foldr1 :: (a -> a -> a) -> Located a -> a

foldl1 :: (a -> a -> a) -> Located a -> a

toList :: Located a -> [a]

null :: Located a -> Bool

length :: Located a -> Int

elem :: Eq a => a -> Located a -> Bool

maximum :: Ord a => Located a -> a

minimum :: Ord a => Located a -> a

sum :: Num a => Located a -> a

product :: Num a => Located a -> a

Traversable Located

Methods

traverse :: Applicative f => (a -> f b) -> Located a -> f (Located b)

sequenceA :: Applicative f => Located (f a) -> f (Located a)

mapM :: Monad m => (a -> m b) -> Located a -> m (Located b)

sequence :: Monad m => Located (m a) -> m (Located a)

Read a => Read (Located a)

Methods

readsPrec :: Int -> ReadS (Located a)

readList :: ReadS [Located a]

readPrec :: ReadPrec (Located a)

readListPrec :: ReadPrec [Located a]

Show a => Show (Located a)

Methods

showsPrec :: Int -> Located a -> ShowS

show :: Located a -> String

showList :: [Located a] -> ShowS

data Position

A position in a text file

Constructors

Position

Fields

• posIndex :: !Int

  zero-based character index

• posLine :: !Int

  one-based line number

• posColumn :: !Int

  one-based column number

Instances

Read Position

Methods

readsPrec :: Int -> ReadS Position

readList :: ReadS [Position]

readPrec :: ReadPrec Position

readListPrec :: ReadPrec [Position]

Show Position

Methods

showsPrec :: Int -> Position -> ShowS

show :: Position -> String

showList :: [Position] -> ShowS

data Token

The token type used by Config.Lexer and Config.Parser

Constructors

StringToken Text

string literal

BareKeyToken Text

bare table key

IntegerToken Integer

integer literal

DoubleToken Double

floating -point literal

ZonedTimeToken ZonedTime

offset date-time

LocalTimeToken LocalTime

local date-time

TimeOfDayToken TimeOfDay

local time

DayToken Day

local date

CommaToken

,

PeriodToken

.

LeftBracketToken

[

RightBracketToken

[

LeftBraceToken

{

RightBraceToken

}

EqualToken

=

TrueToken

true

FalseToken

false

ErrorToken LexerError

lexical error

EofToken

end-of-file

Instances

Read Token

Methods

readsPrec :: Int -> ReadS Token

readList :: ReadS [Token]

readPrec :: ReadPrec Token

readListPrec :: ReadPrec [Token]

Show Token

Methods

showsPrec :: Int -> Token -> ShowS

show :: Token -> String

showList :: [Token] -> ShowS