Toml.Bi.Code

Types

type BiToml a = Bi Env St a

Specialied Bi type alias for Toml monad. Keeps TOML object either as environment or state.

type Env = ExceptT DecodeException (Reader TOML)

Immutable environment for Toml conversion. This is r type variable in Bijection data type.

type St = MaybeT (State TOML)

Mutable context for Toml conversion. This is w type variable in Bijection 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

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

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

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 :: BiToml a -> Text -> Either DecodeException a

Convert textual representation of toml into user data type.

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

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

encode :: BiToml a -> a -> Text

Convert object to textual representation.