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

Applicative (Siphon f c)

Defined in Siphon.Types

Methods

pure :: a -> Siphon f c a

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

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

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

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

Functor (Siphon f c)

Defined in Siphon.Types

Methods

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

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

newtype Indexed a

Constructors

Indexed

Fields

• indexedIndex :: Int

Instances

Eq1 Indexed

Defined in Siphon.Types

Methods

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

Show1 Indexed

Defined in Siphon.Types

Methods

liftShowsPrec :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> Int -> Indexed a -> ShowS

liftShowList :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> [Indexed a] -> ShowS

Functor Indexed

Defined in Siphon.Types

Methods

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

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

Read (Indexed a)

Defined in Siphon.Types

Methods

readsPrec :: Int -> ReadS (Indexed a)

readList :: ReadS [Indexed a]

readPrec :: ReadPrec (Indexed a)

readListPrec :: ReadPrec [Indexed a]

Show (Indexed a)

Defined in Siphon.Types

Methods

showsPrec :: Int -> Indexed a -> ShowS

show :: Indexed a -> String

showList :: [Indexed a] -> ShowS

Eq (Indexed a)

Defined in Siphon.Types

Methods

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

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

Ord (Indexed a)

Defined in Siphon.Types

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

data SiphonError

Constructors

SiphonError

Fields

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

Instances

Exception SiphonError

Defined in Siphon.Types

Methods

toException :: SiphonError -> SomeException

fromException :: SomeException -> Maybe SiphonError

displayException :: SiphonError -> String

Read SiphonError

Defined in Siphon.Types

Methods

readsPrec :: Int -> ReadS SiphonError

readList :: ReadS [SiphonError]

readPrec :: ReadPrec SiphonError

readListPrec :: ReadPrec [SiphonError]

Show SiphonError

Defined in Siphon.Types

Methods

showsPrec :: Int -> SiphonError -> ShowS

show :: SiphonError -> String

showList :: [SiphonError] -> ShowS

Eq SiphonError

Defined in Siphon.Types

Methods

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

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

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

Read RowError

Defined in Siphon.Types

Methods

readsPrec :: Int -> ReadS RowError

readList :: ReadS [RowError]

readPrec :: ReadPrec RowError

readListPrec :: ReadPrec [RowError]

Show RowError

Defined in Siphon.Types

Methods

showsPrec :: Int -> RowError -> ShowS

show :: RowError -> String

showList :: [RowError] -> ShowS

Eq RowError

Defined in Siphon.Types

Methods

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

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

data CellError

Constructors

CellError

Fields

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

Instances

Read CellError

Defined in Siphon.Types

Methods

readsPrec :: Int -> ReadS CellError

readList :: ReadS [CellError]

readPrec :: ReadPrec CellError

readListPrec :: ReadPrec [CellError]

Show CellError

Defined in Siphon.Types

Methods

showsPrec :: Int -> CellError -> ShowS

show :: CellError -> String

showList :: [CellError] -> ShowS

Eq CellError

Defined in Siphon.Types

Methods

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

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