Copyright	(c) 2018-2022 Kowainik
License	MPL-2.0
Maintainer	Kowainik <xrom.xkov@gmail.com>
Stability	Stable
Portability	Portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Toml.Codec.Error

Description

Core error types, including TomlDecodeError and LoadTomlException.

Since: 1.3.0.0

Synopsis

data TomlDecodeError
- = BiMapError !Key !TomlBiMapError
- | KeyNotFound !Key
- | TableNotFound !Key
- | TableArrayNotFound !Key
- | ParseError !TomlParseError
- | NotExactDecode !TOML
prettyTomlDecodeErrors :: [TomlDecodeError] -> Text
prettyTomlDecodeError :: TomlDecodeError -> Text
data LoadTomlException = LoadTomlException !FilePath !Text

Documentation

data TomlDecodeError Source #

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

Since: 1.3.0.0

Constructors

BiMapError !Key !TomlBiMapError
KeyNotFound !Key	No such key
TableNotFound !Key	No such table
TableArrayNotFound !Key	No such table array Since: 1.3.0.0
ParseError !TomlParseError	Exception during parsing
NotExactDecode !TOML	Unused field left in the decoded TOML. Since: 1.3.2.0

Instances

Instances details

Generic TomlDecodeError Source #
Instance details Defined in Toml.Codec.Error Associated Types type Rep TomlDecodeError :: Type -> Type # Methods from :: TomlDecodeError -> Rep TomlDecodeError x # to :: Rep TomlDecodeError x -> TomlDecodeError #
Show TomlDecodeError Source #
Instance details Defined in Toml.Codec.Error Methods showsPrec :: Int -> TomlDecodeError -> ShowS # show :: TomlDecodeError -> String # showList :: [TomlDecodeError] -> ShowS #
NFData TomlDecodeError Source #
Instance details Defined in Toml.Codec.Error Methods rnf :: TomlDecodeError -> () #
Eq TomlDecodeError Source #
Instance details Defined in Toml.Codec.Error Methods (==) :: TomlDecodeError -> TomlDecodeError -> Bool # (/=) :: TomlDecodeError -> TomlDecodeError -> Bool #
type Rep TomlDecodeError Source #
Instance details Defined in Toml.Codec.Error type Rep TomlDecodeError = D1 ('MetaData "TomlDecodeError" "Toml.Codec.Error" "tomland-1.3.3.3-Ih5ryp7Jmpp9EbGekxhWoS" 'False) ((C1 ('MetaCons "BiMapError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Key) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TomlBiMapError)) :+: (C1 ('MetaCons "KeyNotFound" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Key)) :+: C1 ('MetaCons "TableNotFound" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Key)))) :+: (C1 ('MetaCons "TableArrayNotFound" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Key)) :+: (C1 ('MetaCons "ParseError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TomlParseError)) :+: C1 ('MetaCons "NotExactDecode" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TOML)))))

prettyTomlDecodeErrors :: [TomlDecodeError] -> Text Source #

Converts TomlDecodeErrors into pretty human-readable text.

Since: 1.3.0.0

prettyTomlDecodeError :: TomlDecodeError -> Text Source #

Converts TomlDecodeError into pretty human-readable text.

Since: 1.3.0.0

data LoadTomlException Source #

File loading error data type.

Since: 0.3.1

Constructors

LoadTomlException !FilePath !Text

Instances

Instances details

Exception LoadTomlException Source #	Since: 0.3.1
Instance details Defined in Toml.Codec.Error Methods toException :: LoadTomlException -> SomeException # fromException :: SomeException -> Maybe LoadTomlException # displayException :: LoadTomlException -> String #
Show LoadTomlException Source #	Since: 0.3.1
Instance details Defined in Toml.Codec.Error Methods showsPrec :: Int -> LoadTomlException -> ShowS # show :: LoadTomlException -> String # showList :: [LoadTomlException] -> ShowS #