Moduletoml-parser-2.0.2.0Haskell2010

Toml.Semantics.Types

This module provides the type for the semantics of a TOML file. All dotted keys are resolved in this representation. Each table is a Map with a single level of keys.

Values are parameterized over an annotation type to allow values to be attributed to a file location. When values are constructed programmatically, there might not be any interesting annotations. In this case a trivial () unit annotation can be used. The Value type-synonym and related pattern synonyms can make using this case more convenient.

Contents

Unlocated value synonyms
Annotated values
Utilities

Synopsis

type Value
type Table
data Value'
pattern Integer
pattern Double
pattern Text
pattern Bool
pattern ZonedTime
pattern Day
pattern LocalTime
pattern TimeOfDay
pattern List
pattern Table
newtype Table'
value forgetValueAnns
value forgetTableAnns
value valueAnn
value valueType

Packagetoml-parser-2.0.2.0
Exports18
LanguageHaskell2010
LicenceISC
SourceTypes.hs

Unlocated value synonyms

typetype Value = Value' ()

Source#

A Value' with trivial annotations

typetype Table = Table' ()

Source#

A Table' with trivial annotations

Annotated values

datadata Value' a

Source#

Semantic TOML value with all table assignments resolved.

Constructors

Integer' a Integer
Double' a Double
List' a [Value' a]
Table' a (Table' a)
Bool' a Bool
Text' a Text
TimeOfDay' a TimeOfDay
ZonedTime' a ZonedTime
LocalTime' a LocalTime
Day' a Day

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

Functor Value'Defined in toml-parser-2.0.2.0 · Toml.Semantics.Types
Derived
Foldable Value'Defined in toml-parser-2.0.2.0 · Toml.Semantics.Types
Derived
Traversable Value'Defined in toml-parser-2.0.2.0 · Toml.Semantics.Types
Derived
FromValue ValueDefined in toml-parser-2.0.2.0 · Toml.Schema.FromValue
Matches all values, used for pass-through
ToValue ValueDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
Identity function
Eq a => Eq (Value' a)Defined in toml-parser-2.0.2.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.2.0 · Toml.Semantics.Types
Default instance
Show a => Show (Value' a)Defined in toml-parser-2.0.2.0 · Toml.Semantics.Types
Default instance
() ~ a => IsString (Value' a)Defined in toml-parser-2.0.2.0 · Toml.Semantics.Types
Constructs a TOML string literal.
```
fromString = String
```

patternpattern Integer :: Integer -> Value

patternpattern Double :: Double -> Value

patternpattern Text :: Text -> Value

patternpattern Bool :: Bool -> Value

patternpattern ZonedTime :: ZonedTime -> Value

patternpattern Day :: Day -> Value

patternpattern LocalTime :: LocalTime -> Value

patternpattern TimeOfDay :: TimeOfDay -> Value

patternpattern List :: [Value] -> Value

patternpattern Table :: Table -> Value

newtypenewtype Table' a

Source#

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.2.0 · Toml.Semantics.Types
Derived
Foldable Table'Defined in toml-parser-2.0.2.0 · Toml.Semantics.Types
Derived
Traversable Table'Defined in toml-parser-2.0.2.0 · Toml.Semantics.Types
Derived
FromValue TableDefined in toml-parser-2.0.2.0 · Toml.Schema.FromValue
Eq a => Eq (Table' a)Defined in toml-parser-2.0.2.0 · Toml.Semantics.Types
Default instance
Read a => Read (Table' a)Defined in toml-parser-2.0.2.0 · Toml.Semantics.Types
Default instance
Show a => Show (Table' a)Defined in toml-parser-2.0.2.0 · Toml.Semantics.Types
Default instance
ToTable (Table' a)Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue (Table' a)Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue

Utilities

valueforgetValueAnns :: Value' a -> Value

Source#

Replaces annotations with a unit.

valueforgetTableAnns :: Table' a -> Table

Source#

Replaces annotations with a unit.

valuevalueAnn :: Value' a -> a

Source#

Extract the top-level annotation from a value.

valuevalueType :: Value' l -> String

Source#

String representation of the kind of value using TOML vocabulary