Data.Sv.Decode.Error

Documentation

data DecodeError e

DecodeError is a value indicating what went wrong during a parse or decode. Its constructor indictates the type of error which occured, and there is usually an associated string with more finely-grained details.

Constructors

UnexpectedEndOfRow

I was looking for another field, but I am at the end of the row

ExpectedEndOfRow (Vector (SpacedField e))

I should be at the end of the row, but I found extra fields

UnknownCategoricalValue e [[e]]

This decoder was built using the categorical primitive for categorical data

BadParse e

The parser failed, meaning decoding proper didn't even begin

BadDecode e

Some other kind of decoding failure occured

Instances

Functor DecodeError

Methods

fmap :: (a -> b) -> DecodeError a -> DecodeError b

(<$) :: a -> DecodeError b -> DecodeError a

Eq e => Eq (DecodeError e)

Methods

(==) :: DecodeError e -> DecodeError e -> Bool

(/=) :: DecodeError e -> DecodeError e -> Bool

Ord e => Ord (DecodeError e)

Methods

compare :: DecodeError e -> DecodeError e -> Ordering

(<) :: DecodeError e -> DecodeError e -> Bool

(<=) :: DecodeError e -> DecodeError e -> Bool

(>) :: DecodeError e -> DecodeError e -> Bool

(>=) :: DecodeError e -> DecodeError e -> Bool

max :: DecodeError e -> DecodeError e -> DecodeError e

min :: DecodeError e -> DecodeError e -> DecodeError e

Show e => Show (DecodeError e)

Methods

showsPrec :: Int -> DecodeError e -> ShowS

show :: DecodeError e -> String

showList :: [DecodeError e] -> ShowS

Generic (DecodeError e)

Associated Types

type Rep (DecodeError e) :: * -> *

Methods

from :: DecodeError e -> Rep (DecodeError e) x

to :: Rep (DecodeError e) x -> DecodeError e

NFData e => NFData (DecodeError e)

Methods

rnf :: DecodeError e -> ()

type Rep (DecodeError e)

type Rep (DecodeError e) = D1 * (MetaData "DecodeError" "Data.Sv.Decode.Type" "sv-0.1-LEjGD2ajzYS6ZNIUObPicZ" False) ((:+:) * ((:+:) * (C1 * (MetaCons "UnexpectedEndOfRow" PrefixI False) (U1 *)) (C1 * (MetaCons "ExpectedEndOfRow" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Vector (SpacedField e)))))) ((:+:) * (C1 * (MetaCons "UnknownCategoricalValue" PrefixI False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * e)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [[e]])))) ((:+:) * (C1 * (MetaCons "BadParse" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * e))) (C1 * (MetaCons "BadDecode" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * e))))))

newtype DecodeErrors e

DecodeErrors is a Semigroup full of DecodeError. It is used as the error side of a DecodeValidation. When multiple errors occur, they will be collected.

Constructors

DecodeErrors (NonEmpty (DecodeError e))

Instances

Functor DecodeErrors

Methods

fmap :: (a -> b) -> DecodeErrors a -> DecodeErrors b

(<$) :: a -> DecodeErrors b -> DecodeErrors a

Eq e => Eq (DecodeErrors e)

Methods

(==) :: DecodeErrors e -> DecodeErrors e -> Bool

(/=) :: DecodeErrors e -> DecodeErrors e -> Bool

Ord e => Ord (DecodeErrors e)

Methods

compare :: DecodeErrors e -> DecodeErrors e -> Ordering

(<) :: DecodeErrors e -> DecodeErrors e -> Bool

(<=) :: DecodeErrors e -> DecodeErrors e -> Bool

(>) :: DecodeErrors e -> DecodeErrors e -> Bool

(>=) :: DecodeErrors e -> DecodeErrors e -> Bool

max :: DecodeErrors e -> DecodeErrors e -> DecodeErrors e

min :: DecodeErrors e -> DecodeErrors e -> DecodeErrors e

Show e => Show (DecodeErrors e)

Methods

showsPrec :: Int -> DecodeErrors e -> ShowS

show :: DecodeErrors e -> String

showList :: [DecodeErrors e] -> ShowS

Generic (DecodeErrors e)

Associated Types

type Rep (DecodeErrors e) :: * -> *

Methods

from :: DecodeErrors e -> Rep (DecodeErrors e) x

to :: Rep (DecodeErrors e) x -> DecodeErrors e

Semigroup (DecodeErrors e)

Methods

(<>) :: DecodeErrors e -> DecodeErrors e -> DecodeErrors e

sconcat :: NonEmpty (DecodeErrors e) -> DecodeErrors e

stimes :: Integral b => b -> DecodeErrors e -> DecodeErrors e

NFData e => NFData (DecodeErrors e)

Methods

rnf :: DecodeErrors e -> ()

type Rep (DecodeErrors e)

type Rep (DecodeErrors e) = D1 * (MetaData "DecodeErrors" "Data.Sv.Decode.Type" "sv-0.1-LEjGD2ajzYS6ZNIUObPicZ" True) (C1 * (MetaCons "DecodeErrors" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (NonEmpty (DecodeError e)))))

Convenience constructors

decodeError :: DecodeError e -> DecodeValidation e a

Build a failing DecodeValidation

unexpectedEndOfRow :: DecodeValidation e a

Fail with UnexpectedEndOfRow

expectedEndOfRow :: Vector (SpacedField e) -> DecodeValidation e a

Fail with ExpectedEndOfRow. This takes the rest of the row, so that it can be displayed to the user.

unknownCategoricalValue :: e -> [[e]] -> DecodeValidation e a

Fail with UnknownCategoricalValue. It takes the unknown value and the list of good categorical values.

This mostly exists to be used by the categorical function.

badParse :: e -> DecodeValidation e a

Fail with BadParse with the given message. This is for when the parse step fails, and decoding does not even begin.

badDecode :: e -> DecodeValidation e a

Fail with BadDecode with the given message. This is something of a generic error for when decoding a field goes wrong.

Conversions

validateEither :: Either (DecodeError e) a -> DecodeValidation e a

Build a DecodeValidation from an Either

validateEither' :: (e -> DecodeError e') -> Either e a -> DecodeValidation e' a

Build a DecodeValidation from an Either, given a function to build the error.

validateMaybe :: DecodeError e -> Maybe b -> DecodeValidation e b

Build a DecodeValidation from a Maybe. You have to supply an error to use in the Nothing case

validateMaybe' :: (a -> Maybe b) -> DecodeError e -> a -> DecodeValidation e b

Build a DecodeValidation from a function that returns a Maybe You have to supply an error to use in the Nothing case

trifectaResultToEither :: Result a -> Either String a

Helper to convert Text.Trifecta Result to Either.

validateTrifectaResult :: (String -> DecodeError e) -> Result a -> DecodeValidation e a

Convert a Text.Trifecta Result to a DecodeValidation

Re-exports from validation

bindValidation :: Validation e a -> (a -> Validation e b) -> Validation e b

bindValidation binds through an Validation, which is useful for composing Validations sequentially. Note that despite having a bind function of the correct type, Validation is not a monad. The reason is, this bind does not accumulate errors, so it does not agree with the Applicative instance.

There is nothing wrong with using this function, it just does not make a valid Monad instance.