Toml

This module parses TOML into semantically meaningful values.

This parser implements TOML 1.0.0 https://toml.io/en/v1.0.0 as carefully as possible.

types

type Table = Map String Value

Representation of a TOML key-value table.

data Value

Semantic TOML value with all table assignments resolved.

Constructors

Integer Integer

Float Double

Array [Value]

Table Table

Bool Bool

String String

TimeOfDay TimeOfDay

ZonedTime ZonedTime

LocalTime LocalTime

Day Day

Instances

Read Value

Defined in Toml.Value

Methods

readsPrec :: Int -> ReadS Value

readList :: ReadS [Value]

readPrec :: ReadPrec Value

readListPrec :: ReadPrec [Value]

Show Value

Defined in Toml.Value

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

Eq Value

Defined in Toml.Value

Methods

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

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

FromValue Value

Defined in Toml.FromValue

Methods

fromValue :: Value -> Matcher Value

listFromValue :: Value -> Matcher [Value]

ToValue Value

Defined in Toml.ToValue

Methods

toValue :: Value -> Value

toValueList :: [Value] -> Value

parsing

parse :: String -> Either String Table

Parse a TOML formatted Value or report an error message.

printing

prettyToml :: Table -> TomlDoc

Render a complete TOML document using top-level table and array of table sections where appropriate.

data DocClass

Annotation used to enable styling pretty-printed TOML

Constructors

TableClass

top-level [key] and [[key]]

KeyClass

dotted keys, left-hand side of assignments

StringClass

string literals

NumberClass

number literals

DateClass

date and time literals

BoolClass

boolean literals

Instances

Read DocClass

Defined in Toml.Pretty

Methods

readsPrec :: Int -> ReadS DocClass

readList :: ReadS [DocClass]

readPrec :: ReadPrec DocClass

readListPrec :: ReadPrec [DocClass]

Show DocClass

Defined in Toml.Pretty

Methods

showsPrec :: Int -> DocClass -> ShowS

show :: DocClass -> String

showList :: [DocClass] -> ShowS

Eq DocClass

Defined in Toml.Pretty

Methods

(==) :: DocClass -> DocClass -> Bool

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

Ord DocClass

Defined in Toml.Pretty

Methods

compare :: DocClass -> DocClass -> Ordering

(<) :: DocClass -> DocClass -> Bool

(<=) :: DocClass -> DocClass -> Bool

(>) :: DocClass -> DocClass -> Bool

(>=) :: DocClass -> DocClass -> Bool

max :: DocClass -> DocClass -> DocClass

min :: DocClass -> DocClass -> DocClass

Serialization

decode :: FromTable a => String -> Result a

Use the FromTable instance to decode a value from a TOML string.

encode :: ToTable a => a -> TomlDoc

Use the ToTable instance to encode a value to a TOML string.

data Result a

Computation outcome with error and warning messages.

Constructors

Failure String

Success [String] a

Instances

Read a => Read (Result a)

Defined in Toml.FromValue.Matcher

Methods

readsPrec :: Int -> ReadS (Result a)

readList :: ReadS [Result a]

readPrec :: ReadPrec (Result a)

readListPrec :: ReadPrec [Result a]

Show a => Show (Result a)

Defined in Toml.FromValue.Matcher

Methods

showsPrec :: Int -> Result a -> ShowS

show :: Result a -> String

showList :: [Result a] -> ShowS

Eq a => Eq (Result a)

Defined in Toml.FromValue.Matcher

Methods

(==) :: Result a -> Result a -> Bool

(/=) :: Result a -> Result a -> Bool

Ord a => Ord (Result a)

Defined in Toml.FromValue.Matcher

Methods

compare :: Result a -> Result a -> Ordering

(<) :: Result a -> Result a -> Bool

(<=) :: Result a -> Result a -> Bool

(>) :: Result a -> Result a -> Bool

(>=) :: Result a -> Result a -> Bool

max :: Result a -> Result a -> Result a

min :: Result a -> Result a -> Result a