Safe Haskell	None
Language	Haskell2010

System.Process.Common

Contents

Orphan instances

Synopsis

class ProcessMaker a where
class ListLikeIO text char => ListLikeProcessIO text char where
class (IsString text, Monoid text, ListLike text char) => ProcessText text char
class Monoid result => ProcessResult text result | result -> text where
readProcessWithExitCode :: ListLikeProcessIO text char => FilePath -> [String] -> text -> IO (ExitCode, text, text)
readCreateProcessWithExitCode :: (ProcessMaker maker, ListLikeProcessIO text char) => maker -> text -> IO (ExitCode, text, text)
readCreateProcessStrict :: (ProcessMaker maker, ProcessResult text result, ListLikeProcessIO text char) => maker -> text -> IO result
readCreateProcessLazy :: (ProcessMaker maker, ProcessResult a b, ListLikeProcessIO a c) => maker -> a -> IO b
showCmdSpecForUser :: CmdSpec -> String
showCreateProcessForUser :: CreateProcess -> String

Documentation

class ProcessMaker a where #

Minimal complete definition

process, showProcessMakerForUser

Methods

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

showProcessMakerForUser :: a -> String #

Instances

ProcessMaker CreateProcess #	This is the usual maker argument to `readCreateProcessLazy`.
Instance details Defined in System.Process.Common Methods process :: CreateProcess -> IO (Handle, Handle, Handle, ProcessHandle) # showProcessMakerForUser :: CreateProcess -> String #
ProcessMaker (CreateProcess, BufferMode, BufferMode) #	Passing this to `readCreateProcessLazy` 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.
Instance details Defined in System.Process.Common Methods process :: (CreateProcess, BufferMode, BufferMode) -> IO (Handle, Handle, Handle, ProcessHandle) # showProcessMakerForUser :: (CreateProcess, BufferMode, BufferMode) -> String #

class ListLikeIO text char => ListLikeProcessIO text char where #

Process IO is based on the ListLikeIO class from the ListLike package

Minimal complete definition

forceOutput, readChunks

Methods

forceOutput :: text -> IO text #

readChunks :: Handle -> IO [text] #

Read from a handle, returning a lazy list of the monoid a.

Instances

ListLikeProcessIO String Char #	Like `readProcessWithExitCode` that takes a `CreateProcess`.
Instance details Defined in System.Process.ListLike Methods forceOutput :: String -> IO String # readChunks :: Handle -> IO [String] #
ListLikeProcessIO Chars Char #	Like `readProcessWithExitCode`, but specialized for `Text`
Instance details Defined in System.Process.Chars Methods forceOutput :: Chars -> IO Chars # readChunks :: Handle -> IO [Chars] #
ListLikeProcessIO ByteString Word8 #	Like `readProcessWithExitCode`, but using `ByteString`
Instance details Defined in System.Process.ByteString.Lazy Methods forceOutput :: ByteString -> IO ByteString # readChunks :: Handle -> IO [ByteString] #
ListLikeProcessIO ByteString Word8 #	Like `readProcessWithExitCode`, but using `ByteString`
Instance details Defined in System.Process.ByteString Methods forceOutput :: ByteString -> IO ByteString # readChunks :: Handle -> IO [ByteString] #
ListLikeProcessIO Builder Char #	Like `readProcessWithExitCode`, but using `Text`
Instance details Defined in System.Process.Text.Builder Methods forceOutput :: Builder -> IO Builder # readChunks :: Handle -> IO [Builder] #
ListLikeProcessIO Text Char #	Like `readProcessWithExitCode`, but using `Text`
Instance details Defined in System.Process.Text.Lazy Methods forceOutput :: Text -> IO Text # readChunks :: Handle -> IO [Text] #
ListLikeProcessIO Text Char #	Like `readProcessWithExitCode`, but using `Text`
Instance details Defined in System.Process.Text Methods forceOutput :: Text -> IO Text # readChunks :: Handle -> IO [Text] #

class (IsString text, Monoid text, ListLike text char) => ProcessText text char #

Instances

ProcessText String Char #
Instance details Defined in System.Process.ListLike
ProcessText ByteString Word8 #
Instance details Defined in System.Process.ByteString.Lazy
ProcessText ByteString Word8 #
Instance details Defined in System.Process.ByteString
ProcessText Text Char #
Instance details Defined in System.Process.Text.Lazy
ProcessText Text Char #
Instance details Defined in System.Process.Text

class Monoid result => ProcessResult text result | result -> text where #

Minimal complete definition

pidf, outf, errf, intf, codef

Methods

pidf :: ProcessHandle -> result #

outf :: text -> result #

errf :: text -> result #

intf :: SomeException -> result #

codef :: ExitCode -> result #

Instances

ListLikeProcessIO a c => ProcessResult a [Chunk a] #
Instance details Defined in System.Process.ListLike Methods pidf :: ProcessHandle -> [Chunk a] # outf :: a -> [Chunk a] # errf :: a -> [Chunk a] # intf :: SomeException -> [Chunk a] # codef :: ExitCode -> [Chunk a] #
ListLikeProcessIO a c => ProcessResult a (ExitCode, [Chunk a]) #
Instance details Defined in System.Process.ListLike 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 text char => ProcessResult text (ExitCode, text, text) #
Instance details Defined in System.Process.Common Methods pidf :: ProcessHandle -> (ExitCode, text, text) # outf :: text -> (ExitCode, text, text) # errf :: text -> (ExitCode, text, text) # intf :: SomeException -> (ExitCode, text, text) # codef :: ExitCode -> (ExitCode, text, text) #

readProcessWithExitCode #

Arguments

:: ListLikeProcessIO text char
=> FilePath	command to run
-> [String]	any arguments
-> text	standard input
-> IO (ExitCode, text, text)	exitcode, stdout, stderr

Like readProcessWithExitCode, but with generalized input and output type. Aside from the usual text-like types, the output can be a list of Chunk a. This lets you process the chunks received from stdout and stderr lazil, in the order they are received, as well as the exit code. Utilities to handle Chunks are provided in System.Process.ListLike.

readCreateProcessWithExitCode #

Arguments

:: (ProcessMaker maker, ListLikeProcessIO text char)
=> maker	command and arguments to run
-> text	standard input
-> IO (ExitCode, text, text)	exitcode, stdout, stderr

readCreateProcessStrict :: (ProcessMaker maker, ProcessResult text result, ListLikeProcessIO text char) => maker -> text -> IO result #

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

Like readCreateProcessStrict, but the output is read lazily.

showCmdSpecForUser :: CmdSpec -> String #

showCreateProcessForUser :: CreateProcess -> String #

System.Process utility functions.

Orphan instances

Semigroup ExitCode #
Instance details Methods (<>) :: ExitCode -> ExitCode -> ExitCode # sconcat :: NonEmpty ExitCode -> ExitCode # stimes :: Integral b => b -> ExitCode -> ExitCode #
Monoid ExitCode #	A process usually has one `ExitCode` at the end of its output, this `Monoid` instance lets us build the type returned by `readProcessWithExitCode`.
Instance details Methods mempty :: ExitCode # mappend :: ExitCode -> ExitCode -> ExitCode # mconcat :: [ExitCode] -> ExitCode #