Copyright	(c) Eric Mertens 2023
License	ISC
Maintainer	emertens@gmail.com
Safe Haskell	Safe-Inferred
Language	Haskell2010

Toml.ToValue

Contents

Table construction

Description

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 from a Table.

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

Synopsis

class ToValue a where
- toValue :: a -> Value
- toValueList :: [a] -> Value
class ToValue a => ToTable a where
- toTable :: a -> Table
defaultTableToValue :: ToTable a => a -> Value
table :: [(String, Value)] -> Value
(.=) :: ToValue a => String -> a -> (String, Value)

Documentation

class ToValue a where Source #

Class for types that can be embedded into Value

Minimal complete definition

toValue

Methods

toValue :: a -> Value Source #

Embed a single thing into a TOML value.

toValueList :: [a] -> Value Source #

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.

Instances

Instances details

ToValue Int16 Source #
Instance details Defined in Toml.ToValue Methods toValue :: Int16 -> Value Source # toValueList :: [Int16] -> Value Source #
ToValue Int32 Source #
Instance details Defined in Toml.ToValue Methods toValue :: Int32 -> Value Source # toValueList :: [Int32] -> Value Source #
ToValue Int64 Source #
Instance details Defined in Toml.ToValue Methods toValue :: Int64 -> Value Source # toValueList :: [Int64] -> Value Source #
ToValue Int8 Source #
Instance details Defined in Toml.ToValue Methods toValue :: Int8 -> Value Source # toValueList :: [Int8] -> Value Source #
ToValue Word16 Source #
Instance details Defined in Toml.ToValue Methods toValue :: Word16 -> Value Source # toValueList :: [Word16] -> Value Source #
ToValue Word32 Source #
Instance details Defined in Toml.ToValue Methods toValue :: Word32 -> Value Source # toValueList :: [Word32] -> Value Source #
ToValue Word64 Source #
Instance details Defined in Toml.ToValue Methods toValue :: Word64 -> Value Source # toValueList :: [Word64] -> Value Source #
ToValue Word8 Source #
Instance details Defined in Toml.ToValue Methods toValue :: Word8 -> Value Source # toValueList :: [Word8] -> Value Source #
ToValue Day Source #
Instance details Defined in Toml.ToValue Methods toValue :: Day -> Value Source # toValueList :: [Day] -> Value Source #
ToValue LocalTime Source #
Instance details Defined in Toml.ToValue Methods toValue :: LocalTime -> Value Source # toValueList :: [LocalTime] -> Value Source #
ToValue TimeOfDay Source #
Instance details Defined in Toml.ToValue Methods toValue :: TimeOfDay -> Value Source # toValueList :: [TimeOfDay] -> Value Source #
ToValue ZonedTime Source #
Instance details Defined in Toml.ToValue Methods toValue :: ZonedTime -> Value Source # toValueList :: [ZonedTime] -> Value Source #
ToValue Value Source #
Instance details Defined in Toml.ToValue Methods toValue :: Value -> Value Source # toValueList :: [Value] -> Value Source #
ToValue Integer Source #
Instance details Defined in Toml.ToValue Methods toValue :: Integer -> Value Source # toValueList :: [Integer] -> Value Source #
ToValue Natural Source #
Instance details Defined in Toml.ToValue Methods toValue :: Natural -> Value Source # toValueList :: [Natural] -> Value Source #
ToValue Bool Source #
Instance details Defined in Toml.ToValue Methods toValue :: Bool -> Value Source # toValueList :: [Bool] -> Value Source #
ToValue Char Source #	Single characters are encoded as singleton strings. Lists of characters are encoded as a single string value.
Instance details Defined in Toml.ToValue Methods toValue :: Char -> Value Source # toValueList :: [Char] -> Value Source #
ToValue Double Source #
Instance details Defined in Toml.ToValue Methods toValue :: Double -> Value Source # toValueList :: [Double] -> Value Source #
ToValue Float Source #
Instance details Defined in Toml.ToValue Methods toValue :: Float -> Value Source # toValueList :: [Float] -> Value Source #
ToValue Int Source #
Instance details Defined in Toml.ToValue Methods toValue :: Int -> Value Source # toValueList :: [Int] -> Value Source #
ToValue Word Source #
Instance details Defined in Toml.ToValue Methods toValue :: Word -> Value Source # toValueList :: [Word] -> Value Source #
ToValue a => ToValue [a] Source #	This instance defers to the list element's `toValueList` implementation.
Instance details Defined in Toml.ToValue Methods toValue :: [a] -> Value Source # toValueList :: [[a]] -> Value Source #
(k ~ String, ToValue v) => ToValue (Map k v) Source #	Since: 1.0.1.0
Instance details Defined in Toml.ToValue Methods toValue :: Map k v -> Value Source # toValueList :: [Map k v] -> Value Source #

Table construction

class ToValue a => ToTable a where Source #

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

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

Methods

toTable :: a -> Table Source #

Convert a single value into a table

Instances

Instances details

(k ~ String, ToValue v) => ToTable (Map k v) Source #	Since: 1.0.1.0
Instance details Defined in Toml.ToValue Methods toTable :: Map k v -> Table Source #

defaultTableToValue :: ToTable a => a -> Value Source #

Convenience function for building ToValue instances.

table :: [(String, Value)] -> Value Source #

Build a Table from a list of key-value pairs.

Use .= for a convenient way to build the pairs.

(.=) :: ToValue a => String -> a -> (String, Value) Source #

Convenience function for building key-value pairs while constructing a Table.

table [a .= b, c .= d]