Moduleprocess-extras-0.7.4Haskell2010

System.Process.Run

Flexible control of progress reporting for readCreateProcess and friends.

Contents

Monad transformer
Monad class
Modify moand RunM state parameters
Monadic process runner
Re-exports

Synopsis

type RunT
value runT
data RunState
data OutputStyle
class RunM
value echoStart
value echoEnd
value output
value silent
value dots
value indent
value vlevel
value quieter
value noisier
value lazy
value strict
value message
value run

Packageprocess-extras-0.7.4
Exports18
LanguageHaskell2010
LicenceMIT
SourceRun.hs

Monad transformer

typetype RunT text (m :: Type -> Type) = StateT (RunState text) m

valuerunT :: (MonadIO m, ProcessText text char) => RunT text m a -> m a

datadata RunState text

Source#

This is the state record that controls the output style.

Constructors

RunState
- _output :: OutputStyle
  Overall style of output
- _outprefix :: text
  Prefix for lines of stdout
- _errprefix :: text
  Prefix for lines of stderr
- _echoStart :: Bool
  Echo command as process starts
- _echoEnd :: Bool
  Echo command as process finishes
- _verbosity :: Int
  A progression of progress modes
- _lazy :: Bool
  Use the lazy or strict runner?
- _message :: text
  Extra text for start/end message - e.g. the change root

Instances1Default

ProcessText text char => Default (RunState text)Defined in process-extras-0.7.4 · System.Process.Run

datadata OutputStyle

Constructors

Dots Int
Output one dot per n output characters
All
send process stdout to console stdout and process stderr to console stderr
Indented
Output with prefixes
Silent
No output

Monad class

class

class (MonadState (RunState text) m, ProcessText text char, ListLikeProcessIO text char, MonadIO m, IsString text, Eq char, Dot char) => RunM text char (m :: Type -> Type)

Instances5RunM

(MonadIO m, MonadState (RunState ByteString) m) => RunM ByteString Word8 mDefined in process-extras-0.7.4 · System.Process.Run
(MonadIO m, MonadState (RunState ByteString) m) => RunM ByteString Word8 mDefined in process-extras-0.7.4 · System.Process.Run
(MonadIO m, MonadState (RunState String) m) => RunM String Char mDefined in process-extras-0.7.4 · System.Process.Run
(MonadIO m, MonadState (RunState Text) m) => RunM Text Char mDefined in process-extras-0.7.4 · System.Process.Run
(MonadIO m, MonadState (RunState Text) m) => RunM Text Char mDefined in process-extras-0.7.4 · System.Process.Run

Modify moand RunM state parameters

valueechoStart :: MonadState (RunState t) m => m ()

valueechoEnd :: MonadState (RunState t) m => m ()

valueoutput :: MonadState (RunState t) m => m ()

valuesilent :: MonadState (RunState t) m => m ()

valuedots :: MonadState (RunState t) m => Int -> m ()

valueindent

:: (MonadState (RunState t) m, ListLike t char)
=> t -> t
-> t -> t
-> m ()

Source#

Modify the indentation prefixes for stdout and stderr in the progress monad.

valuevlevel

:: (IsString text, ListLike text char, MonadIO m, MonadState (RunState text) m)
=> Int
-> m ()

Source#

Set verbosity to a specific level from 0 to 3. vlevel :: (MonadIO m, Monoid text, MonadState (RunState text) m) => Int -> m () vlevel :: forall m text char. (IsString text, ListLike text char, MonadIO m) => Int -> m ()

valuequieter :: RunM text char m => m ()

valuenoisier :: RunM text char m => m ()

valuelazy :: RunM text char m => m ()

valuestrict :: RunM text char m => m ()

valuemessage :: RunM text char m => (text -> text) -> m ()

Monadic process runner

valuerun

:: (RunM text char m, ProcessMaker maker, ProcessResult text result)
=> maker
-> text
-> m result

Re-exports

module System.Process.ListLike