Moduletoml-parser-2.0.2.0Haskell2010

Toml.Schema.ToValue

The ToValue class provides a conversion function from application-specific to TOML values.

Because the top-level TOML document is always a table, the ToTable class is for types that specifically support conversion to a Table.

Toml.Schema.Generic can be used to derive instances of ToTable automatically for record types and ToValue for array types.

Contents

Table construction

Synopsis

class ToValue
class ToTable
class ToKey
value defaultTableToValue
value table
value .=

Packagetoml-parser-2.0.2.0
Exports6
LanguageHaskell2010
LicenceISC
SourceToValue.hs

classclass ToValue a where

Source#

Class for types that can be embedded into Value

Methods

toValue :: a -> Value
Embed a single thing into a TOML value.
toValueList :: [a] -> Value
Helper for converting a list of things into a value. This is typically left to be defined by its default implementation and exists to help define the encoding for TOML arrays.

Instances32ToValue, …

ToValue IntegerDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue NaturalDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue Int16Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue Int32Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue Int64Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue Int8Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue BoolDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue CharDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
Single characters are encoded as singleton strings. Lists of characters are encoded as a single string value.
ToValue DoubleDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue FloatDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue IntDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue WordDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue Word16Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue Word32Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue Word64Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue Word8Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue TextDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
Encodes as string literal
ToValue TextDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
Encodes as string literal
ToValue DayDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue UTCTimeDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue LocalTimeDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue TimeOfDayDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue ZonedTimeDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue ValueDefined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
Identity function
Integral a => ToValue (Ratio a)Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
TOML represents floating point numbers with Double. This operation lose precision and can overflow to infinity.
ToValue (Table' a)Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
ToValue a => ToValue (Seq a)Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
Converts to list and encodes that to value
ToValue a => ToValue (NonEmpty a)Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
Converts to list and encodes that to value
ToValue a => ToValue [a]Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
This instance defers to the list element's toValueList implementation.
(Generic a, GToArray (Rep a)) => ToValue (GenericTomlArray a)Defined in toml-parser-2.0.2.0 · Toml.Schema.Generic
Instance derived using genericToArray
(Generic a, GToTable (Rep a)) => ToValue (GenericTomlTable a)Defined in toml-parser-2.0.2.0 · Toml.Schema.Generic
Instance derived from ToTable instance using defaultTableToValue
(ToKey k, ToValue v) => ToValue (Map k v)Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue

Table construction

classclass ToValue a => ToTable a where

Source#

Class for things that can be embedded into a TOML table.

Implement this for things that always embed into a Table and then the ToValue instance can be derived with defaultTableToValue.

instance ToValue Example where
    toValue = defaultTableToValue

-- Option 1: Manual instance
instance ToTable Example where
    toTable x = table ["field1" .= field1 x, "field2" .= field2 x]

-- Option 2: GHC.Generics derived instance using Toml.ToValue.Generic
instance ToTable Example where
    toTable = genericToTable

Methods

toTable :: a -> Table
Convert a single value into a table

Instances3ToTable

ToTable (Table' a)Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue
(Generic a, GToTable (Rep a)) => ToTable (GenericTomlTable a)Defined in toml-parser-2.0.2.0 · Toml.Schema.Generic
Instance derived using genericToTable
(ToKey k, ToValue v) => ToTable (Map k v)Defined in toml-parser-2.0.2.0 · Toml.Schema.ToValue