Siphon

Documentation

data Siphon f c a

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.

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

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

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

data SiphonError

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

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

decodeHeadedUtf8Csv

Arguments

:: Monad m

=> Siphon Headed ByteString a

-> Stream (Of ByteString) m ()

encoded csv

-> Stream (Of a) m (Maybe SiphonError)

encodeHeadedUtf8Csv :: Monad m => Colonnade Headed a ByteString -> Stream (Of a) m r -> Stream (Of ByteString) m r

humanizeSiphonError :: SiphonError -> String

This adds one to the index because text editors consider line number to be one-based, not zero-based.

headed :: c -> (c -> Maybe a) -> Siphon Headed c a

headless :: (c -> Maybe a) -> Siphon Headless c a

indexed :: Int -> (c -> Maybe a) -> Siphon Indexed c a