Moduletoml-parser-2.0.0.0Haskell2010

Toml.Semantics

This module extracts a nested Map representation of a TOML file. It detects invalid key assignments and resolves dotted key assignments.

6 types
5 values

Packagetoml-parser-2.0.0.0
Exports21
LanguageHaskell2010
LicenceISC
SourceSemantics.hs

Types

14 declarations

typetype Value = Value' ()

A Value' with trivial annotations

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

typetype Table = Table' ()

A Table' with trivial annotations

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

Validation

3 declarations

valuesemantics :: [Expr a] -> Either (SemanticError a) (Table' a)

Extracts a semantic value from a sequence of raw TOML expressions, or reports a semantic error if one occurs.

datadata SemanticError a

This type represents errors generated when resolving keys in a TOML document.

Constructors

SemanticError
- errorAnn :: a
  Annotation associated with offending key
- errorKey :: Text
- errorKind :: SemanticErrorKind

Instances7Functor, Foldable, Traversable, Eq, Ord, Read, …

Functor SemanticErrorDefined in toml-parser-2.0.0.0 · Toml.Semantics
Foldable SemanticErrorDefined in toml-parser-2.0.0.0 · Toml.Semantics
Traversable SemanticErrorDefined in toml-parser-2.0.0.0 · Toml.Semantics
Eq a => Eq (SemanticError a)Defined in toml-parser-2.0.0.0 · Toml.Semantics
Default instance
Ord a => Ord (SemanticError a)Defined in toml-parser-2.0.0.0 · Toml.Semantics
Default instance
Read a => Read (SemanticError a)Defined in toml-parser-2.0.0.0 · Toml.Semantics
Default instance
Show a => Show (SemanticError a)Defined in toml-parser-2.0.0.0 · Toml.Semantics
Default instance

datadata SemanticErrorKind

Enumeration of the kinds of conflicts a key can generate.

Constructors

AlreadyAssigned
Attempted to assign to a key that was already assigned
ClosedTable
Attempted to open a table already closed
ImplicitlyTable
Attempted to open a tables as an array of tables that was implicitly defined to be a table

Instances4Eq, Ord, Read, Show

Eq SemanticErrorKindDefined in toml-parser-2.0.0.0 · Toml.Semantics
Default instance
Ord SemanticErrorKindDefined in toml-parser-2.0.0.0 · Toml.Semantics
Default instance
Read SemanticErrorKindDefined in toml-parser-2.0.0.0 · Toml.Semantics
Default instance
Show SemanticErrorKindDefined in toml-parser-2.0.0.0 · Toml.Semantics
Default instance

Annotations

4 declarations

valueforgetTableAnns :: Table' a -> Table

Replaces annotations with a unit.

valueforgetValueAnns :: Value' a -> Value

Replaces annotations with a unit.

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