System.Process.ListLike

Re-export all symbols and instances of the process-extras package. Adds the Chunk type with a ProcessOutput instance, and a collectOutput function to turn a list of chunks into any instance of ProcessOutput, such as (ExitCode, String, String). This means you can have readCreateProcess output a list of Chunk, operate on it to do progress reporting, and finally convert it to the type that readProcessWithExitCode woud have returned.

Documentation

class ProcessMaker a where

Minimal complete definition

process

Methods

process :: a -> IO (Handle, Handle, Handle, ProcessHandle)

Instances

ProcessMaker CreateProcess

This is the usual maker argument to readCreateProcess.

Methods

process :: CreateProcess -> IO (Handle, Handle, Handle, ProcessHandle)

ProcessMaker (CreateProcess, BufferMode, BufferMode)

Passing this to readCreateProcess as the maker argument allows you to set the buffer mode of the process stdout and stderr handles just after the handles are created. These are set to BlockBuffering by default, but for running console commands LineBuffering is probably what you want.

Methods

process :: (CreateProcess, BufferMode, BufferMode) -> IO (Handle, Handle, Handle, ProcessHandle)

class ListLikeIO a c => ListLikeProcessIO a c where

Minimal complete definition

forceOutput, readChunks

Methods

forceOutput :: a -> IO a

class Monoid b => ProcessOutput a b | b -> a where

Minimal complete definition

pidf, outf, errf, intf, codef

Methods

pidf :: ProcessHandle -> b

outf :: a -> b

errf :: a -> b

intf :: SomeException -> b

codef :: ExitCode -> b

Instances

ListLikeProcessIO a c => ProcessOutput a [Chunk a]

Methods

pidf :: ProcessHandle -> [Chunk a]

outf :: a -> [Chunk a]

errf :: a -> [Chunk a]

intf :: SomeException -> [Chunk a]

codef :: ExitCode -> [Chunk a]

ListLikeProcessIO a c => ProcessOutput a (ExitCode, [Chunk a])

Methods

pidf :: ProcessHandle -> (ExitCode, [Chunk a])

outf :: a -> (ExitCode, [Chunk a])

errf :: a -> (ExitCode, [Chunk a])

intf :: SomeException -> (ExitCode, [Chunk a])

codef :: ExitCode -> (ExitCode, [Chunk a])

ListLikeProcessIO a c => ProcessOutput a (ExitCode, a, a)

Methods

pidf :: ProcessHandle -> (ExitCode, a, a)

outf :: a -> (ExitCode, a, a)

errf :: a -> (ExitCode, a, a)

intf :: SomeException -> (ExitCode, a, a)

codef :: ExitCode -> (ExitCode, a, a)

readCreateProcess :: (ProcessMaker maker, ProcessOutput a b, ListLikeProcessIO a c) => maker -> a -> IO b

readCreateProcessLazy :: (ProcessMaker maker, ProcessOutput a b, ListLikeProcessIO a c) => maker -> a -> IO b

Like readCreateProcess, but the output is read lazily.

readCreateProcessWithExitCode

Arguments

:: (ProcessMaker maker, ListLikeProcessIO a c)

=> maker

command and arguments to run

-> a

standard input

-> IO (ExitCode, a, a)

exitcode, stdout, stderr

readProcessWithExitCode

Arguments

:: ListLikeProcessIO a c

=> FilePath

command to run

-> [String]

any arguments

-> a

standard input

-> IO (ExitCode, a, a)

exitcode, stdout, stderr

Like readProcessWithExitCode, but with generalized input and output type.

data Chunk a

This type is a concrete representation of the methods of class ProcessOutput. If you take your process output as this type you could, for example, echo all the output and then use collectOutput below to convert it to any other instance of ProcessOutput.

Constructors

ProcessHandle ProcessHandle

This will always come first, before any output or exit code.

Stdout a

Stderr a

Result ExitCode

Exception SomeException

Note that the instances below do not use this constructor.

Instances

ListLikeProcessIO a c => ProcessOutput a [Chunk a]

Methods

pidf :: ProcessHandle -> [Chunk a]

outf :: a -> [Chunk a]

errf :: a -> [Chunk a]

intf :: SomeException -> [Chunk a]

codef :: ExitCode -> [Chunk a]

ListLikeProcessIO a c => ProcessOutput a (ExitCode, [Chunk a])

Methods

pidf :: ProcessHandle -> (ExitCode, [Chunk a])

outf :: a -> (ExitCode, [Chunk a])

errf :: a -> (ExitCode, [Chunk a])

intf :: SomeException -> (ExitCode, [Chunk a])

codef :: ExitCode -> (ExitCode, [Chunk a])

Show a => Show (Chunk a)

Methods

showsPrec :: Int -> Chunk a -> ShowS

show :: Chunk a -> String

showList :: [Chunk a] -> ShowS

collectOutput :: ProcessOutput a b => [Chunk a] -> b

Turn a [Chunk a] into any other instance of ProcessOutput.

foldOutput :: (ProcessHandle -> r) -> (a -> r) -> (a -> r) -> (SomeException -> r) -> (ExitCode -> r) -> Chunk a -> r

writeOutput :: ListLikeIO a c => [Chunk a] -> IO ()

Send Stdout chunks to stdout and Stderr chunks to stderr.

showCreateProcessForUser :: CreateProcess -> String

System.Process utility functions.

showCmdSpecForUser :: CmdSpec -> String

proc :: FilePath -> [String] -> CreateProcess

Construct a CreateProcess record for passing to createProcess, representing a raw command with arguments.

See RawCommand for precise semantics of the specified FilePath.

shell :: String -> CreateProcess

Construct a CreateProcess record for passing to createProcess, representing a command to be passed to the shell.

Orphan instances

Show ProcessHandle

Methods

showsPrec :: Int -> ProcessHandle -> ShowS

show :: ProcessHandle -> String

showList :: [ProcessHandle] -> ShowS

ListLikeProcessIO String Char

Like readProcessWithExitCode that takes a CreateProcess.

Methods

forceOutput :: String -> IO String

readChunks :: Handle -> IO [String]