Toml.Bi.Code

Coding functions like decode and encode. Also contains specialization of Codec for TOML.

Types

type TomlCodec a = BiCodec Env St a

Specialied BiCodec type alias for bidirectional TOML serialization. Keeps TOML object as both environment and state.

type Env = ExceptT DecodeException (Reader TOML)

Immutable environment for TOML conversion. This is r type variable in Codec data type.

type St = MaybeT (State TOML)

Mutable context for TOML conversion. This is w type variable in Codec data type.

MaybeT (State TOML) a
    = State TOML (Maybe a)
    = TOML -> (Maybe a, TOML)

Exceptions

data DecodeException

Type of exception for converting from TOML to user custom data type.

Constructors

TrivialError

BiMapError TomlBiMapError

KeyNotFound Key

No such key

TableNotFound Key

No such table

TypeMismatch Key Text TValue

Expected type vs actual type

ParseError ParseException

Exception during parsing

Instances

Eq DecodeException

Defined in Toml.Bi.Code

Methods

(==) :: DecodeException -> DecodeException -> Bool

(/=) :: DecodeException -> DecodeException -> Bool

Show DecodeException

Defined in Toml.Bi.Code

Methods

showsPrec :: Int -> DecodeException -> ShowS

show :: DecodeException -> String

showList :: [DecodeException] -> ShowS

Generic DecodeException

Defined in Toml.Bi.Code

Associated Types

type Rep DecodeException :: Type -> Type

Methods

from :: DecodeException -> Rep DecodeException x

to :: Rep DecodeException x -> DecodeException

Semigroup DecodeException

Defined in Toml.Bi.Code

Methods

(<>) :: DecodeException -> DecodeException -> DecodeException

sconcat :: NonEmpty DecodeException -> DecodeException

stimes :: Integral b => b -> DecodeException -> DecodeException

Monoid DecodeException

Defined in Toml.Bi.Code

Methods

mempty :: DecodeException

mappend :: DecodeException -> DecodeException -> DecodeException

mconcat :: [DecodeException] -> DecodeException

NFData DecodeException

Defined in Toml.Bi.Code

Methods

rnf :: DecodeException -> ()

type Rep DecodeException

Defined in Toml.Bi.Code

type Rep DecodeException = D1 (MetaData "DecodeException" "Toml.Bi.Code" "tomland-1.1.0.0-inplace" False) ((C1 (MetaCons "TrivialError" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "BiMapError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TomlBiMapError)) :+: C1 (MetaCons "KeyNotFound" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key)))) :+: (C1 (MetaCons "TableNotFound" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key)) :+: (C1 (MetaCons "TypeMismatch" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TValue))) :+: C1 (MetaCons "ParseError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParseException)))))

data LoadTomlException

File loading error data type.

Constructors

LoadTomlException FilePath Text

Instances

Show LoadTomlException

Defined in Toml.Bi.Code

Methods

showsPrec :: Int -> LoadTomlException -> ShowS

show :: LoadTomlException -> String

showList :: [LoadTomlException] -> ShowS

Exception LoadTomlException

Defined in Toml.Bi.Code

Methods

toException :: LoadTomlException -> SomeException

fromException :: SomeException -> Maybe LoadTomlException

displayException :: LoadTomlException -> String

prettyException :: DecodeException -> Text

Converts DecodeException into pretty human-readable text.

Encode/Decode

decode :: TomlCodec a -> Text -> Either DecodeException a

Convert textual representation of toml into user data type.

decodeFile :: MonadIO m => TomlCodec a -> FilePath -> m a

Decode a value from a file. In case of parse errors, throws LoadTomlException.

runTomlCodec :: TomlCodec a -> TOML -> Either DecodeException a

Convert toml into user data type.

encode :: TomlCodec a -> a -> Text

Convert object to textual representation.

execTomlCodec :: TomlCodec a -> a -> TOML

Runs codecWrite of TomlCodec and returns intermediate TOML AST.