Generic codec for arbitrary data types. Uses field names as keys.

Since: 1.1.0.0

Generic codec with options for arbitrary data types.

Since: 1.1.0.0

Generic codec that uses stripTypeNameOptions.

Since: 1.1.0.0

Options to configure various parameters of generic encoding. Specifically:

• tomlOptionsFieldModifier: how to translate field names to TOML keys?

Since: 1.1.0.0

Same as TomlOptions but with all data type information erased. This data type is used internally. Define your options using TomlOptions data type.

Since: 1.1.0.0

Options that use stripTypeNamePrefix as tomlOptionsFieldModifier.

Since: 1.1.0.0

Strips name of the type name from field name prefix.

>>> data UserData = UserData { userDataId :: Int, userDataShortInfo :: Text }
>>> stripTypeNamePrefix (Proxy @UserData) "userDataId"
"id"
>>> stripTypeNamePrefix (Proxy @UserData) "userDataShortInfo"
"shortInfo"
>>> stripTypeNamePrefix (Proxy @UserData) "udStats"
"stats"
>>> stripTypeNamePrefix (Proxy @UserData) "fooBar"
"bar"
>>> stripTypeNamePrefix (Proxy @UserData) "name"
"name"

Since: 1.1.0.0

Helper typeclass for generic deriving. This instance tells how the data type should be coded if it's a field of another data type.

NOTE: If you implement TOML codecs for your data types manually, prefer more explicit Toml.int or Toml.text instead of implicit Toml.hasCodec. Implement instances of this typeclass only when using genericCodec and when your custom data types are not covered here.

Since: 1.1.0.0

This typeclass tells how the data type should be coded as an item of a list. Lists in TOML can have two types: primitive and table of arrays.

• If hasItemCodec returns Left: primitive arrays codec is used.
• If hasItemCodec returns 'Right:' table of arrays codec is used.

Since: 1.1.0.0

Helper class to derive TOML codecs generically.

Since: 1.1.0.0

Newtype wrapper over ByteString to be used for text values.

Since: 1.3.0.0

Newtype wrapper over ByteString to be used for array of integers representation.

Since: 1.3.0.0

Newtype wrapper over lazy ByteString to be used for text values.

Since: 1.3.0.0

Newtype wrapper over lazy ByteString to be used for array of integers representation.

Since: 1.3.0.0

newtype for generic deriving of HasCodec typeclass for custom data types that should we wrapped into separate table. Use it only for data types that are fields of another data types.

data Person = Person
    { personName    :: !Text
    , personAddress :: !Address
    } deriving (Generic)

data Address = Address
    { addressStreet :: !Text
    , addressHouse  :: !Int
    } deriving (Generic)
      deriving HasCodec via TomlTable Address

personCodec :: TomlCodec Person
personCodec = stripTypeNameCodec

personCodec corresponds to the TOML of the following structure:

name = "foo"
[address]
    addressStreet = "Bar"
    addressHouse = 42

Since: 1.3.0.0

newtype for generic deriving of HasCodec typeclass for custom data types that should be wrapped into a separate table.

Similar to TomlTable but also strips the data type name prefix from TOML keys.

personCodec from the TomlTable comment corresponds to the TOML of the following structure:

name = "foo"
[address]
    street = "Bar"
    house = 42

Since: 1.3.2.0