Data.Sv.Decode.Type

Documentation

newtype Decode e s a

A Decode e s a is for decoding some fields from a CSV row into our type a.

The second type parameter (s) is the input string type (usually ByteString or Text). The first type parameter (e) is the type of strings which occur in errors. Under most circumstances you want these type paraters to coincide, but they don't have to. They are two separate type parameters instead of one so that Decode can have a Profunctor instance.

There are primitive Decodes, and combinators for composing or otherwise manipulating them. In particular, Decode is an Applicative functor and an Alt from the semigroupoids package, also known as a SemiAlternative.

Decode is not a Monad, but we can perform monad-like operations on it with >>== or bindDecode

Constructors

Decode

Fields

• unwrapDecode :: Compose (DecodeState s) (DecodeValidation e) a

Instances

Profunctor (Decode e)

Defined in Data.Sv.Decode.Type

Methods

dimap :: (a -> b) -> (c -> d) -> Decode e b c -> Decode e a d

lmap :: (a -> b) -> Decode e b c -> Decode e a c

rmap :: (b -> c) -> Decode e a b -> Decode e a c

(#.) :: Coercible c b => q b c -> Decode e a b -> Decode e a c

(.#) :: Coercible b a => Decode e b c -> q a b -> Decode e a c

Semigroupoid (Decode e :: * -> * -> *)

Defined in Data.Sv.Decode.Type

Methods

o :: Decode e j k1 -> Decode e i j -> Decode e i k1

Functor (Decode e s)

Defined in Data.Sv.Decode.Type

Methods

fmap :: (a -> b) -> Decode e s a -> Decode e s b

(<$) :: a -> Decode e s b -> Decode e s a

Applicative (Decode e s)

Defined in Data.Sv.Decode.Type

Methods

pure :: a -> Decode e s a

(<*>) :: Decode e s (a -> b) -> Decode e s a -> Decode e s b

liftA2 :: (a -> b -> c) -> Decode e s a -> Decode e s b -> Decode e s c

(*>) :: Decode e s a -> Decode e s b -> Decode e s b

(<*) :: Decode e s a -> Decode e s b -> Decode e s a

Apply (Decode e s)

Defined in Data.Sv.Decode.Type

Methods

(<.>) :: Decode e s (a -> b) -> Decode e s a -> Decode e s b

(.>) :: Decode e s a -> Decode e s b -> Decode e s b

(<.) :: Decode e s a -> Decode e s b -> Decode e s a

liftF2 :: (a -> b -> c) -> Decode e s a -> Decode e s b -> Decode e s c

Alt (Decode e s)

Defined in Data.Sv.Decode.Type

Methods

(<!>) :: Decode e s a -> Decode e s a -> Decode e s a

some :: Applicative (Decode e s) => Decode e s a -> Decode e s [a]

many :: Applicative (Decode e s) => Decode e s a -> Decode e s [a]

type Decode' s = Decode s s

Decode' is Decode with the input and error types the same. You usually want them to be the same, and most primitives are set up this way.

buildDecode :: (Vector s -> Ind -> (DecodeValidation e a, Ind)) -> Decode e s a

Convenient constructor for Decode that handles all the newtype noise for you.

newtype DecodeState s a

As we decode a row of data, we walk through its fields. This Monad keeps track of our position.

Constructors

DecodeState

Fields

• getDecodeState :: ReaderT (Vector s) (State Ind) a

Instances

Profunctor DecodeState

Defined in Data.Sv.Decode.Type

Methods

dimap :: (a -> b) -> (c -> d) -> DecodeState b c -> DecodeState a d

lmap :: (a -> b) -> DecodeState b c -> DecodeState a c

rmap :: (b -> c) -> DecodeState a b -> DecodeState a c

(#.) :: Coercible c b => q b c -> DecodeState a b -> DecodeState a c

(.#) :: Coercible b a => DecodeState b c -> q a b -> DecodeState a c

MonadState Ind (DecodeState s)

Defined in Data.Sv.Decode.Type

Methods

get :: DecodeState s Ind

put :: Ind -> DecodeState s ()

state :: (Ind -> (a, Ind)) -> DecodeState s a

Monad (DecodeState s)

Defined in Data.Sv.Decode.Type

Methods

(>>=) :: DecodeState s a -> (a -> DecodeState s b) -> DecodeState s b

(>>) :: DecodeState s a -> DecodeState s b -> DecodeState s b

return :: a -> DecodeState s a

fail :: String -> DecodeState s a

Functor (DecodeState s)

Defined in Data.Sv.Decode.Type

Methods

fmap :: (a -> b) -> DecodeState s a -> DecodeState s b

(<$) :: a -> DecodeState s b -> DecodeState s a

Applicative (DecodeState s)

Defined in Data.Sv.Decode.Type

Methods

pure :: a -> DecodeState s a

(<*>) :: DecodeState s (a -> b) -> DecodeState s a -> DecodeState s b

liftA2 :: (a -> b -> c) -> DecodeState s a -> DecodeState s b -> DecodeState s c

(*>) :: DecodeState s a -> DecodeState s b -> DecodeState s b

(<*) :: DecodeState s a -> DecodeState s b -> DecodeState s a

Apply (DecodeState s)

Defined in Data.Sv.Decode.Type

Methods

(<.>) :: DecodeState s (a -> b) -> DecodeState s a -> DecodeState s b

(.>) :: DecodeState s a -> DecodeState s b -> DecodeState s b

(<.) :: DecodeState s a -> DecodeState s b -> DecodeState s a

liftF2 :: (a -> b -> c) -> DecodeState s a -> DecodeState s b -> DecodeState s c

Bind (DecodeState s)

Defined in Data.Sv.Decode.Type

Methods

(>>-) :: DecodeState s a -> (a -> DecodeState s b) -> DecodeState s b

join :: DecodeState s (DecodeState s a) -> DecodeState s a

MonadReader (Vector s) (DecodeState s)

Defined in Data.Sv.Decode.Type

Methods

ask :: DecodeState s (Vector s)

local :: (Vector s -> Vector s) -> DecodeState s a -> DecodeState s a

reader :: (Vector s -> a) -> DecodeState s a

runDecodeState :: DecodeState s a -> Vector s -> Ind -> (a, Ind)

Convenient function to run a DecodeState

newtype Ind

Newtype for indices into the field vector

Constructors

Ind Int

Instances

Eq Ind

Defined in Data.Sv.Decode.Type

Methods

(==) :: Ind -> Ind -> Bool

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

Ord Ind

Defined in Data.Sv.Decode.Type

Methods

compare :: Ind -> Ind -> Ordering

(<) :: Ind -> Ind -> Bool

(<=) :: Ind -> Ind -> Bool

(>) :: Ind -> Ind -> Bool

(>=) :: Ind -> Ind -> Bool

max :: Ind -> Ind -> Ind

min :: Ind -> Ind -> Ind

Show Ind

Defined in Data.Sv.Decode.Type

Methods

showsPrec :: Int -> Ind -> ShowS

show :: Ind -> String

showList :: [Ind] -> ShowS

MonadState Ind (DecodeState s)

Defined in Data.Sv.Decode.Type

Methods

get :: DecodeState s Ind

put :: Ind -> DecodeState s ()

state :: (Ind -> (a, Ind)) -> DecodeState s a

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 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

Defined in Data.Sv.Decode.Type

Methods

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

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

Eq e => Eq (DecodeError e)

Defined in Data.Sv.Decode.Type

Methods

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

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

Ord e => Ord (DecodeError e)

Defined in Data.Sv.Decode.Type

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)

Defined in Data.Sv.Decode.Type

Methods

showsPrec :: Int -> DecodeError e -> ShowS

show :: DecodeError e -> String

showList :: [DecodeError e] -> ShowS

Generic (DecodeError e)

Defined in Data.Sv.Decode.Type

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)

Defined in Data.Sv.Decode.Type

Methods

rnf :: DecodeError e -> ()

type Rep (DecodeError e)

Defined in Data.Sv.Decode.Type

type Rep (DecodeError e) = D1 (MetaData "DecodeError" "Data.Sv.Decode.Type" "sv-core-0.1-51KgVCUkx8wDPB3DBWyxTK" False) ((C1 (MetaCons "UnexpectedEndOfRow" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ExpectedEndOfRow" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Vector e)))) :+: (C1 (MetaCons "UnknownCategoricalValue" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 e) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [[e]])) :+: (C1 (MetaCons "BadParse" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 e)) :+: C1 (MetaCons "BadDecode" PrefixI False) (S1 (MetaSel (Nothing :: Maybe 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

Defined in Data.Sv.Decode.Type

Methods

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

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

Eq e => Eq (DecodeErrors e)

Defined in Data.Sv.Decode.Type

Methods

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

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

Ord e => Ord (DecodeErrors e)

Defined in Data.Sv.Decode.Type

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)

Defined in Data.Sv.Decode.Type

Methods

showsPrec :: Int -> DecodeErrors e -> ShowS

show :: DecodeErrors e -> String

showList :: [DecodeErrors e] -> ShowS

Generic (DecodeErrors e)

Defined in Data.Sv.Decode.Type

Associated Types

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

Methods

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

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

Semigroup (DecodeErrors e)

Defined in Data.Sv.Decode.Type

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)

Defined in Data.Sv.Decode.Type

Methods

rnf :: DecodeErrors e -> ()

type Rep (DecodeErrors e)

Defined in Data.Sv.Decode.Type

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

type DecodeValidation e = Validation (DecodeErrors e)

DecodeValidation is the error-accumulating Applicative underlying Decode

data Validation err a

An Validation is either a value of the type err or a, similar to Either. However, the Applicative instance for Validation accumulates errors using a Semigroup on err. In contrast, the Applicative for Either returns only the first error.

A consequence of this is that Validation has no Bind or Monad instance. This is because such an instance would violate the law that a Monad's ap must equal the Applicative's <*>

An example of typical usage can be found here.

Constructors

Failure err

Success a

Instances

Bitraversable Validation

Defined in Data.Validation

Methods

bitraverse :: Applicative f => (a -> f c) -> (b -> f d) -> Validation a b -> f (Validation c d)

Bifoldable Validation

Defined in Data.Validation

Methods

bifold :: Monoid m => Validation m m -> m

bifoldMap :: Monoid m => (a -> m) -> (b -> m) -> Validation a b -> m

bifoldr :: (a -> c -> c) -> (b -> c -> c) -> c -> Validation a b -> c

bifoldl :: (c -> a -> c) -> (c -> b -> c) -> c -> Validation a b -> c

Bifunctor Validation

Defined in Data.Validation

Methods

bimap :: (a -> b) -> (c -> d) -> Validation a c -> Validation b d

first :: (a -> b) -> Validation a c -> Validation b c

second :: (b -> c) -> Validation a b -> Validation a c

Swapped Validation

Defined in Data.Validation

Methods

swapped :: (Profunctor p, Functor f) => p (Validation b a) (f (Validation d c)) -> p (Validation a b) (f (Validation c d))

Validate Validation

Defined in Data.Validation

Methods

_Validation :: (Profunctor p, Functor f) => p (Validation e a) (f (Validation g b)) -> p (Validation e a) (f (Validation g b))

_Either :: (Profunctor p, Functor f) => p (Either e a) (f (Either g b)) -> p (Validation e a) (f (Validation g b))

Functor (Validation err)

Defined in Data.Validation

Methods

fmap :: (a -> b) -> Validation err a -> Validation err b

(<$) :: a -> Validation err b -> Validation err a

Semigroup err => Applicative (Validation err)

Defined in Data.Validation

Methods

pure :: a -> Validation err a

(<*>) :: Validation err (a -> b) -> Validation err a -> Validation err b

liftA2 :: (a -> b -> c) -> Validation err a -> Validation err b -> Validation err c

(*>) :: Validation err a -> Validation err b -> Validation err b

(<*) :: Validation err a -> Validation err b -> Validation err a

Foldable (Validation err)

Defined in Data.Validation

Methods

fold :: Monoid m => Validation err m -> m

foldMap :: Monoid m => (a -> m) -> Validation err a -> m

foldr :: (a -> b -> b) -> b -> Validation err a -> b

foldr' :: (a -> b -> b) -> b -> Validation err a -> b

foldl :: (b -> a -> b) -> b -> Validation err a -> b

foldl' :: (b -> a -> b) -> b -> Validation err a -> b

foldr1 :: (a -> a -> a) -> Validation err a -> a

foldl1 :: (a -> a -> a) -> Validation err a -> a

toList :: Validation err a -> [a]

null :: Validation err a -> Bool

length :: Validation err a -> Int

elem :: Eq a => a -> Validation err a -> Bool

maximum :: Ord a => Validation err a -> a

minimum :: Ord a => Validation err a -> a

sum :: Num a => Validation err a -> a

product :: Num a => Validation err a -> a

Traversable (Validation err)

Defined in Data.Validation

Methods

traverse :: Applicative f => (a -> f b) -> Validation err a -> f (Validation err b)

sequenceA :: Applicative f => Validation err (f a) -> f (Validation err a)

mapM :: Monad m => (a -> m b) -> Validation err a -> m (Validation err b)

sequence :: Monad m => Validation err (m a) -> m (Validation err a)

Semigroup err => Apply (Validation err)

Defined in Data.Validation

Methods

(<.>) :: Validation err (a -> b) -> Validation err a -> Validation err b

(.>) :: Validation err a -> Validation err b -> Validation err b

(<.) :: Validation err a -> Validation err b -> Validation err a

liftF2 :: (a -> b -> c) -> Validation err a -> Validation err b -> Validation err c

Alt (Validation err)

Defined in Data.Validation

Methods

(<!>) :: Validation err a -> Validation err a -> Validation err a

some :: Applicative (Validation err) => Validation err a -> Validation err [a]

many :: Applicative (Validation err) => Validation err a -> Validation err [a]

(Eq err, Eq a) => Eq (Validation err a)

Defined in Data.Validation

Methods

(==) :: Validation err a -> Validation err a -> Bool

(/=) :: Validation err a -> Validation err a -> Bool

(Data err, Data a) => Data (Validation err a)

Defined in Data.Validation

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Validation err a -> c (Validation err a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Validation err a)

toConstr :: Validation err a -> Constr

dataTypeOf :: Validation err a -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Validation err a))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Validation err a))

gmapT :: (forall b. Data b => b -> b) -> Validation err a -> Validation err a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Validation err a -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Validation err a -> r

gmapQ :: (forall d. Data d => d -> u) -> Validation err a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Validation err a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Validation err a -> m (Validation err a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Validation err a -> m (Validation err a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Validation err a -> m (Validation err a)

(Ord err, Ord a) => Ord (Validation err a)

Defined in Data.Validation

Methods

compare :: Validation err a -> Validation err a -> Ordering

(<) :: Validation err a -> Validation err a -> Bool

(<=) :: Validation err a -> Validation err a -> Bool

(>) :: Validation err a -> Validation err a -> Bool

(>=) :: Validation err a -> Validation err a -> Bool

max :: Validation err a -> Validation err a -> Validation err a

min :: Validation err a -> Validation err a -> Validation err a

(Show err, Show a) => Show (Validation err a)

Defined in Data.Validation

Methods

showsPrec :: Int -> Validation err a -> ShowS

show :: Validation err a -> String

showList :: [Validation err a] -> ShowS

Generic (Validation err a)

Defined in Data.Validation

Associated Types

type Rep (Validation err a) :: * -> *

Methods

from :: Validation err a -> Rep (Validation err a) x

to :: Rep (Validation err a) x -> Validation err a

Semigroup e => Semigroup (Validation e a)

Defined in Data.Validation

Methods

(<>) :: Validation e a -> Validation e a -> Validation e a

sconcat :: NonEmpty (Validation e a) -> Validation e a

stimes :: Integral b => b -> Validation e a -> Validation e a

Monoid e => Monoid (Validation e a)

Defined in Data.Validation

Methods

mempty :: Validation e a

mappend :: Validation e a -> Validation e a -> Validation e a

mconcat :: [Validation e a] -> Validation e a

(NFData e, NFData a) => NFData (Validation e a)

Defined in Data.Validation

Methods

rnf :: Validation e a -> ()

type Rep (Validation err a)

Defined in Data.Validation

type Rep (Validation err a) = D1 (MetaData "Validation" "Data.Validation" "validation-1-BDhPbXz8xykBrbp6Wg48L3" False) (C1 (MetaCons "Failure" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 err)) :+: C1 (MetaCons "Success" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)))