Moduletoml-parser-2.0.0.0Haskell2010

Toml

This is the high-level interface to the toml-parser library. It enables parsing, printing, and conversion into and out of application-specific representations.

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

Use Toml.Schema to implement functions mapping between TOML values and your application types.

Use Toml.Syntax and Toml.Semantics for low-level TOML syntax processing and semantic validation. Most applications will not need to use these modules directly unless the application is about TOML itself.

The types and functions of this package are parameterized over an annotation type in order to allow applications to provide detailed feedback messages tracked back to specific source locations in an original TOML file. While the default annotation is a simple file position, some applications might upgrade this annotation to track multiple file names or synthetically generated sources. Other applications won't need source location and can replace annotations with a simple unit type.

9 types
13 values

Packagetoml-parser-2.0.0.0
Exports32
LanguageHaskell2010
LicenceISC
SourceToml.hs

Types

2 declarations

typetype Table = Table' ()

A Table' with trivial annotations

typetype Value = Value' ()

A Value' with trivial annotations

Located types

18 declarations

datadata Located a

A value annotated with its text file position

Constructors

Located
- locPosition :: !Position
  position
- locThing :: !a
  thing at position

Instances5Functor, Foldable, Traversable, Read, Show

Functor LocatedDefined in toml-parser-2.0.0.0 · Toml.Syntax.Position
Default instance
Foldable LocatedDefined in toml-parser-2.0.0.0 · Toml.Syntax.Position
Default instance
Traversable LocatedDefined in toml-parser-2.0.0.0 · Toml.Syntax.Position
Default instance
Read a => Read (Located a)Defined in toml-parser-2.0.0.0 · Toml.Syntax.Position
Default instance
Show a => Show (Located a)Defined in toml-parser-2.0.0.0 · Toml.Syntax.Position
Default instance

datadata Position

A position in a text file

Constructors

Position
- posIndex :: !Int
  code-point index (zero-based)
- posLine :: !Int
  line index (one-based)
- posColumn :: !Int
  column index (one-based)

Instances4Eq, Ord, Read, Show

Eq PositionDefined in toml-parser-2.0.0.0 · Toml.Syntax.Position
Default instance
Ord PositionDefined in toml-parser-2.0.0.0 · Toml.Syntax.Position
Default instance
Read PositionDefined in toml-parser-2.0.0.0 · Toml.Syntax.Position
Default instance
Show PositionDefined in toml-parser-2.0.0.0 · Toml.Syntax.Position
Default instance

newtypenewtype Table' a

A table with annotated keys and values.

Constructors

MkTable (Map Text (a, Value' a))

Instances9Functor, Foldable, Traversable, FromValue, Eq, Read, …

Functor Table'Defined in toml-parser-2.0.0.0 · Toml.Semantics.Types
Derived
Foldable Table'Defined in toml-parser-2.0.0.0 · Toml.Semantics.Types
Derived
Traversable Table'Defined in toml-parser-2.0.0.0 · Toml.Semantics.Types
Derived
FromValue TableDefined in toml-parser-2.0.0.0 · Toml.Schema.FromValue
Eq a => Eq (Table' a)Defined in toml-parser-2.0.0.0 · Toml.Semantics.Types
Default instance
Read a => Read (Table' a)Defined in toml-parser-2.0.0.0 · Toml.Semantics.Types
Default instance
Show a => Show (Table' a)Defined in toml-parser-2.0.0.0 · Toml.Semantics.Types
Default instance
ToTable (Table' a)Defined in toml-parser-2.0.0.0 · Toml.Schema.ToValue
ToValue (Table' a)Defined in toml-parser-2.0.0.0 · Toml.Schema.ToValue

datadata Value' a

Semantic TOML value with all table assignments resolved.

Constructors

Instances9Functor, Foldable, Traversable, FromValue, ToValue, Eq, …

Functor Value'Defined in toml-parser-2.0.0.0 · Toml.Semantics.Types
Derived
Foldable Value'Defined in toml-parser-2.0.0.0 · Toml.Semantics.Types
Derived
Traversable Value'Defined in toml-parser-2.0.0.0 · Toml.Semantics.Types
Derived
FromValue ValueDefined in toml-parser-2.0.0.0 · Toml.Schema.FromValue
Matches all values, used for pass-through
ToValue ValueDefined in toml-parser-2.0.0.0 · Toml.Schema.ToValue
Identity function
Eq a => Eq (Value' a)Defined in toml-parser-2.0.0.0 · Toml.Semantics.Types
Nearly default instance except ZonedTime doesn't have an Eq instance. ZonedTime values are equal if their times and time-zones are both equal.
Read a => Read (Value' a)Defined in toml-parser-2.0.0.0 · Toml.Semantics.Types
Default instance
Show a => Show (Value' a)Defined in toml-parser-2.0.0.0 · Toml.Semantics.Types
Default instance
() ~ a => IsString (Value' a)Defined in toml-parser-2.0.0.0 · Toml.Semantics.Types
Constructs a TOML string literal.
```
fromString = String
```

patternpattern Table :: Table -> Value

patternpattern Text :: Text -> Value

patternpattern List :: [Value] -> Value

patternpattern ZonedTime :: ZonedTime -> Value

patternpattern LocalTime :: LocalTime -> Value

patternpattern Day :: Day -> Value

patternpattern TimeOfDay :: TimeOfDay -> Value

patternpattern Integer :: Integer -> Value

patternpattern Double :: Double -> Value

patternpattern Bool :: Bool -> Value

valuevalueAnn :: Value' a -> a

Extract the top-level annotation from a value.

valuevalueType :: Value' l -> String

String representation of the kind of value using TOML vocabulary

valueforgetTableAnns :: Table' a -> Table

Replaces annotations with a unit.

valueforgetValueAnns :: Value' a -> Value

Replaces annotations with a unit.

Parsing

5 declarations

valuedecode' :: FromValue a => Text -> Result DecodeError a

Decode TOML syntax into an application value.

valuedecode :: FromValue a => Text -> Result String a

Wrapper rending error and warning messages into human-readable strings.

valueparse :: Text -> Either String (Table' Position)

Parse a TOML formatted String or report a human-readable error message.

datadata DecodeError

Sum of errors that can occur during TOML decoding

datadata Result e a

Computation outcome with error and warning messages. Multiple error messages can occur when multiple alternatives all fail. Resolving any one of the error messages could allow the computation to succeed.

Constructors

Failure [e]
error messages
Success [e] a
warning messages and result

Instances4Eq, Ord, Read, Show

(Eq e, Eq a) => Eq (Result e a)Defined in toml-parser-2.0.0.0 · Toml.Schema.Matcher
Default instance
(Ord e, Ord a) => Ord (Result e a)Defined in toml-parser-2.0.0.0 · Toml.Schema.Matcher
Default instance
(Read e, Read a) => Read (Result e a)Defined in toml-parser-2.0.0.0 · Toml.Schema.Matcher
Default instance
(Show e, Show a) => Show (Result e a)Defined in toml-parser-2.0.0.0 · Toml.Schema.Matcher
Default instance

Printing

3 declarations

valueencode :: ToTable a => a -> TomlDoc

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

valueprettyToml

:: Table' a
table to print
-> TomlDoc
TOML syntax

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

Keys are sorted alphabetically. To provide a custom ordering, see prettyTomlOrdered.

datadata 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

Instances4Eq, Ord, Read, Show

Eq DocClassDefined in toml-parser-2.0.0.0 · Toml.Pretty
Ord DocClassDefined in toml-parser-2.0.0.0 · Toml.Pretty
Read DocClassDefined in toml-parser-2.0.0.0 · Toml.Pretty
Show DocClassDefined in toml-parser-2.0.0.0 · Toml.Pretty

Error rendering

4 declarations

valueprettyDecodeError :: DecodeError -> String

Human-readable representation of a DecodeError

valueprettyLocated :: Located String -> String

Pretty-print as line:col: message

valueprettyMatchMessage :: MatchMessage Position -> String

Render a TOML decoding error as a human-readable string.

valueprettySemanticError :: SemanticError Position -> String

Render a semantic TOML error in a human-readable string.