Text.Chatty.Scanner

Provides a typeclass for all monads that may scan text.

Documentation

class Monad m => ChScanner m where

A typeclass for all monads that may read input.

Minimal complete definition

mscan1, mscanL, mscannable, mready

Methods

mscan1 :: m Char

Read one single character

mscanL :: m String

Lazily read all the input.

mscannable :: m Bool

Input readable? (not EOF)

mscanh :: m (Maybe Handle)

Return FD handle, if available

mready :: m Bool

Input available yet?

Instances

ChScanner IO

MonadIO m => ChScanner (InRedirT m)

Monad m => ChScanner (QuietT m)

Monad m => ChScanner (HereStringT m)

ChScanner m => ChScanner (ScannerBufferT m)

ChAtoms m => ChScanner (FileScannerT m)

Monad m => ChScanner (StateT String m)

newtype HereStringT m a

HereStringT holds a given string and uses it as input for the function (much like here-strings in the shell)

Constructors

HereString

Fields

runHereStringT :: String -> m (a, String)

Instances

MonadTrans HereStringT

RedirectionHeredoc String HereStringT a a

Monad m => Monad (HereStringT m)

Monad m => Functor (HereStringT m)

Monad m => Applicative (HereStringT m)

MonadIO m => MonadIO (HereStringT m)

ChFinalizer m => ChFinalizer (HereStringT m)

Monad m => ChScanner (HereStringT m)

Monad m => ChBufferedScanner (HereStringT m)

newtype QuietT m a

QuietT does not convey any input (much like <devnull in the shell)

Constructors

Quiet

Fields

runQuietT :: m a

Instances

MonadTrans QuietT

RedirectionSource EmptyI QuietT a a

Monad m => Monad (QuietT m)

Functor m => Functor (QuietT m)

(Functor m, Monad m) => Applicative (QuietT m)

Monad m => ChScanner (QuietT m)

newtype InRedirT m a

InRedirT redirects all input to a given handle (much like <filename in the shell)

Constructors

InRedir

Fields

runInRedirT :: Handle -> m a

Instances

MonadTrans InRedirT

RedirectionSource Handle InRedirT a a

RedirectionSource FilePath InRedirT a a

Monad m => Monad (InRedirT m)

Monad m => Functor (InRedirT m)

Monad m => Applicative (InRedirT m)

MonadIO m => MonadIO (InRedirT m)

ChFinalizer m => ChFinalizer (InRedirT m)

MonadIO m => ChScanner (InRedirT m)

type InRedir = InRedirT (HandleCloserT IO)

InRedirT on an IO monad

runInRedir :: InRedir a -> Handle -> IO a

Run InRedir with handle

runInRedirFT :: (Functor m, MonadIO m, ChFinalizer m) => InRedirT m a -> FilePath -> m a

Run InRedirT with a filename

runInRedirF :: InRedir a -> FilePath -> IO a

Run InRedir with a filename

mscanLn :: ChScanner m => m String

Line-scanning alternative to mscan1/L

mscanN :: ChScanner m => Int -> m String

Scan a fixed number of chars

data EmptyI

Redirection source that does not provide any output

Constructors

EmptyI

Instances

RedirectionSource EmptyI QuietT a a

class RedirectionSource t mt a r | t -> mt, t a -> r where

Class for all primitive redirection sources.

Methods

(.<.) :: (ChFinalizer m, Functor m, MonadIO m, ChScanner (mt m)) => mt m a -> t -> m r

Redirection

Instances

RedirectionSource Handle InRedirT a a

RedirectionSource FilePath InRedirT a a

RedirectionSource EmptyI QuietT a a

class RedirectionHeredoc t mt a r | t -> mt, t a -> r where

Class for all Here-Documents

Methods

(.<<.) :: (Functor m, ChScanner (mt m)) => mt m a -> t -> m r

Redirection

Instances

RedirectionHeredoc String HereStringT a a