System.Process.Run

Flexible control of progress reporting for readCreateProcess and friends.

Monad transformer

type RunT text m = StateT (RunState text) m

runT :: forall m text char a. (MonadIO m, ProcessText text char) => RunT text m a -> m a

data RunState text

This is the state record that controls the output style.

Constructors

RunState

Fields

• _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

Instances

ProcessText text char => Default (RunState text)

Methods

def :: RunState text

data 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 (MonadState (RunState text) m, ProcessText text char, ListLikeProcessIO text char, MonadIO m, IsString text, Eq char, Dot char) => RunM text char m

Instances

(MonadIO m, MonadState (RunState String) m) => RunM String Char m

(MonadIO m, MonadState (RunState ByteString) m) => RunM ByteString Word8 m

(MonadIO m, MonadState (RunState ByteString) m) => RunM ByteString Word8 m

(MonadIO m, MonadState (RunState Text) m) => RunM Text Char m

(MonadIO m, MonadState (RunState Text) m) => RunM Text Char m

Modify moand RunM state parameters

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

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

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

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

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

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

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

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

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 ()

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

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

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

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

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

Monadic process runner

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

Re-exports

module System.Process.ListLike