Siphon.Types

Documentation

data Siphon f c a where

This just actually a specialization of the free applicative. Check out Control.Applicative.Free in the free library to learn more about this. The meanings of the fields are documented slightly more in the source code. Unfortunately, haddock does not play nicely with GADTs.

Constructors

SiphonPure :: !a -> Siphon f c a

SiphonAp :: !(f c) -> !(c -> Maybe a) -> !(Siphon f c (a -> b)) -> Siphon f c b

Instances

Functor (Siphon f c)

Methods

fmap :: (a -> b) -> Siphon f c a -> Siphon f c b

(<$) :: a -> Siphon f c b -> Siphon f c a

Applicative (Siphon f c)

Methods

pure :: a -> Siphon f c a

(<*>) :: Siphon f c (a -> b) -> Siphon f c a -> Siphon f c b

liftA2 :: (a -> b -> c) -> Siphon f c a -> Siphon f c b -> Siphon f c c

(*>) :: Siphon f c a -> Siphon f c b -> Siphon f c b

(<*) :: Siphon f c a -> Siphon f c b -> Siphon f c a

newtype Indexed a

Constructors

Indexed

Fields

• indexedIndex :: Int

Instances

Functor Indexed

Methods

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

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

Eq (Indexed a)

Methods

(==) :: Indexed a -> Indexed a -> Bool

(/=) :: Indexed a -> Indexed a -> Bool

Ord (Indexed a)

Methods

compare :: Indexed a -> Indexed a -> Ordering

(<) :: Indexed a -> Indexed a -> Bool

(<=) :: Indexed a -> Indexed a -> Bool

(>) :: Indexed a -> Indexed a -> Bool

(>=) :: Indexed a -> Indexed a -> Bool

max :: Indexed a -> Indexed a -> Indexed a

min :: Indexed a -> Indexed a -> Indexed a

Read (Indexed a)

Methods

readsPrec :: Int -> ReadS (Indexed a)

readList :: ReadS [Indexed a]

readPrec :: ReadPrec (Indexed a)

readListPrec :: ReadPrec [Indexed a]

Show (Indexed a)

Methods

showsPrec :: Int -> Indexed a -> ShowS

show :: Indexed a -> String

showList :: [Indexed a] -> ShowS

data SiphonError

Constructors

SiphonError

Fields

• siphonErrorRow :: !Int
• siphonErrorCause :: !RowError

Instances

Eq SiphonError

Methods

(==) :: SiphonError -> SiphonError -> Bool

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

Read SiphonError

Methods

readsPrec :: Int -> ReadS SiphonError

readList :: ReadS [SiphonError]

readPrec :: ReadPrec SiphonError

readListPrec :: ReadPrec [SiphonError]

Show SiphonError

Methods

showsPrec :: Int -> SiphonError -> ShowS

show :: SiphonError -> String

showList :: [SiphonError] -> ShowS

Exception SiphonError

Methods

toException :: SiphonError -> SomeException

fromException :: SomeException -> Maybe SiphonError

displayException :: SiphonError -> String

data RowError

Constructors

RowErrorParse

Error occurred parsing the document into cells

RowErrorDecode !(Vector CellError)

Error decoding the content

RowErrorSize !Int !Int

Wrong number of cells in the row

RowErrorHeaders !(Vector (Vector CellError)) !(Vector Text) !(Vector Int)

Three parts: (a) Multiple header cells matched the same expected cell, (b) Headers that were missing, (c) Missing headers that were lambdas. They cannot be shown so instead their positions in the Siphon are given.

RowErrorHeaderSize !Int !Int

Not enough cells in header, expected, actual

RowErrorMalformed !Int

Error decoding unicode content, column number

Instances

Eq RowError

Methods

(==) :: RowError -> RowError -> Bool

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

Read RowError

Methods

readsPrec :: Int -> ReadS RowError

readList :: ReadS [RowError]

readPrec :: ReadPrec RowError

readListPrec :: ReadPrec [RowError]

Show RowError

Methods

showsPrec :: Int -> RowError -> ShowS

show :: RowError -> String

showList :: [RowError] -> ShowS

data CellError

Constructors

CellError

Fields

• cellErrorColumn :: !Int
• cellErrorContent :: !Text

Instances

Eq CellError

Methods

(==) :: CellError -> CellError -> Bool

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

Read CellError

Methods

readsPrec :: Int -> ReadS CellError

readList :: ReadS [CellError]

readPrec :: ReadPrec CellError

readListPrec :: ReadPrec [CellError]

Show CellError

Methods

showsPrec :: Int -> CellError -> ShowS

show :: CellError -> String

showList :: [CellError] -> ShowS