Safe Haskell	None
Language	GHC2021

Effects.Process.Typed

Contents

Effect
Types
ProcessConfig
Setters
Stream specs
- Built-in stream specs
- Create your own stream spec
Launch a process
Exception-throwing functions
Interact with a process
- Process exit code
- Process streams
Exceptions
Re-exports
Unsafe functions

Description

Provides the MonadTypedProcess typeclass for process effects.

Since: 0.1

Synopsis

class Monad m => MonadTypedProcess (m :: Type -> Type) where
- runProcess :: HasCallStack => ProcessConfig stdin stdout stderr -> m ExitCode
- readProcess :: HasCallStack => ProcessConfig stdin stdoutIgnored stderrIgnored -> m (ExitCode, ByteString, ByteString)
- readProcessStdout :: HasCallStack => ProcessConfig stdin stdoutIgnored stderr -> m (ExitCode, ByteString)
- readProcessStderr :: HasCallStack => ProcessConfig stdin stdout stderrIgnored -> m (ExitCode, ByteString)
- readProcessInterleaved :: HasCallStack => ProcessConfig stdin stdoutIgnored stderrIgnored -> m (ExitCode, ByteString)
- withProcessWait :: HasCallStack => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> m a) -> m a
- withProcessTerm :: HasCallStack => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> m a) -> m a
- startProcess :: HasCallStack => ProcessConfig stdin stdout stderr -> m (Process stdin stdout stderr)
- stopProcess :: HasCallStack => Process stdin stdout stderr -> m ()
- runProcess_ :: HasCallStack => ProcessConfig stdin stdout stderr -> m ()
- readProcess_ :: HasCallStack => ProcessConfig stdin stdoutIgnored stderrIgnored -> m (ByteString, ByteString)
- readProcessStdout_ :: HasCallStack => ProcessConfig stdin stdoutIgnored stderr -> m ByteString
- readProcessStderr_ :: HasCallStack => ProcessConfig stdin stdout stderrIgnored -> m ByteString
- readProcessInterleaved_ :: HasCallStack => ProcessConfig stdin stdoutIgnored stderrIgnored -> m ByteString
- withProcessWait_ :: HasCallStack => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> m a) -> m a
- withProcessTerm_ :: HasCallStack => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> m a) -> m a
- waitExitCode :: HasCallStack => Process stdin stdout stderr -> m ExitCode
- getExitCode :: HasCallStack => Process stdin stdout stderr -> m (Maybe ExitCode)
- checkExitCode :: HasCallStack => Process stdin stdout stderr -> m ()
data ProcessConfig stdin stdout stderr
data StreamSpec (streamType :: StreamType) a
data StreamType
data Process stdin stdout stderr
proc :: FilePath -> [String] -> ProcessConfig () () ()
shell :: String -> ProcessConfig () () ()
setStdin :: StreamSpec 'STInput stdin -> ProcessConfig stdin0 stdout stderr -> ProcessConfig stdin stdout stderr
setStdout :: StreamSpec 'STOutput stdout -> ProcessConfig stdin stdout0 stderr -> ProcessConfig stdin stdout stderr
setStderr :: StreamSpec 'STOutput stderr -> ProcessConfig stdin stdout stderr0 -> ProcessConfig stdin stdout stderr
setWorkingDir :: FilePath -> ProcessConfig stdin stdout stderr -> ProcessConfig stdin stdout stderr
setWorkingDirInherit :: ProcessConfig stdin stdout stderr -> ProcessConfig stdin stdout stderr
setEnv :: [(String, String)] -> ProcessConfig stdin stdout stderr -> ProcessConfig stdin stdout stderr
setEnvInherit :: ProcessConfig stdin stdout stderr -> ProcessConfig stdin stdout stderr
setCloseFds :: Bool -> ProcessConfig stdin stdout stderr -> ProcessConfig stdin stdout stderr
setCreateGroup :: Bool -> ProcessConfig stdin stdout stderr -> ProcessConfig stdin stdout stderr
setDelegateCtlc :: Bool -> ProcessConfig stdin stdout stderr -> ProcessConfig stdin stdout stderr
setDetachConsole :: Bool -> ProcessConfig stdin stdout stderr -> ProcessConfig stdin stdout stderr
setCreateNewConsole :: Bool -> ProcessConfig stdin stdout stderr -> ProcessConfig stdin stdout stderr
setNewSession :: Bool -> ProcessConfig stdin stdout stderr -> ProcessConfig stdin stdout stderr
setChildGroup :: GroupID -> ProcessConfig stdin stdout stderr -> ProcessConfig stdin stdout stderr
setChildGroupInherit :: ProcessConfig stdin stdout stderr -> ProcessConfig stdin stdout stderr
setChildUser :: UserID -> ProcessConfig stdin stdout stderr -> ProcessConfig stdin stdout stderr
setChildUserInherit :: ProcessConfig stdin stdout stderr -> ProcessConfig stdin stdout stderr
inherit :: forall (anyStreamType :: StreamType). StreamSpec anyStreamType ()
nullStream :: forall (anyStreamType :: StreamType). StreamSpec anyStreamType ()
closed :: forall (anyStreamType :: StreamType). StreamSpec anyStreamType ()
byteStringInput :: ByteString -> StreamSpec 'STInput ()
byteStringOutput :: StreamSpec 'STOutput (STM ByteString)
createPipe :: forall (anyStreamType :: StreamType). StreamSpec anyStreamType Handle
useHandleOpen :: forall (anyStreamType :: StreamType). Handle -> StreamSpec anyStreamType ()
useHandleClose :: forall (anyStreamType :: StreamType). Handle -> StreamSpec anyStreamType ()
mkStreamSpec :: forall a (streamType :: StreamType). StdStream -> (ProcessConfig () () () -> Maybe Handle -> IO (a, IO ())) -> StreamSpec streamType a
mkPipeStreamSpec :: forall a (streamType :: StreamType). (ProcessConfig () () () -> Handle -> IO (a, IO ())) -> StreamSpec streamType a
runProcess :: (MonadTypedProcess m, HasCallStack) => ProcessConfig stdin stdout stderr -> m ExitCode
readProcess :: (MonadTypedProcess m, HasCallStack) => ProcessConfig stdin stdoutIgnored stderrIgnored -> m (ExitCode, ByteString, ByteString)
readProcessStdout :: (MonadTypedProcess m, HasCallStack) => ProcessConfig stdin stdoutIgnored stderr -> m (ExitCode, ByteString)
readProcessStderr :: (MonadTypedProcess m, HasCallStack) => ProcessConfig stdin stdout stderrIgnored -> m (ExitCode, ByteString)
readProcessInterleaved :: (MonadTypedProcess m, HasCallStack) => ProcessConfig stdin stdoutIgnored stderrIgnored -> m (ExitCode, ByteString)
withProcessWait :: (MonadTypedProcess m, HasCallStack) => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> m a) -> m a
withProcessTerm :: (MonadTypedProcess m, HasCallStack) => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> m a) -> m a
startProcess :: (MonadTypedProcess m, HasCallStack) => ProcessConfig stdin stdout stderr -> m (Process stdin stdout stderr)
stopProcess :: (MonadTypedProcess m, HasCallStack) => Process stdin stdout stderr -> m ()
runProcess_ :: (MonadTypedProcess m, HasCallStack) => ProcessConfig stdin stdout stderr -> m ()
readProcess_ :: (MonadTypedProcess m, HasCallStack) => ProcessConfig stdin stdoutIgnored stderrIgnored -> m (ByteString, ByteString)
readProcessStdout_ :: (MonadTypedProcess m, HasCallStack) => ProcessConfig stdin stdoutIgnored stderr -> m ByteString
readProcessStderr_ :: (MonadTypedProcess m, HasCallStack) => ProcessConfig stdin stdout stderrIgnored -> m ByteString
readProcessInterleaved_ :: (MonadTypedProcess m, HasCallStack) => ProcessConfig stdin stdoutIgnored stderrIgnored -> m ByteString
withProcessWait_ :: (MonadTypedProcess m, HasCallStack) => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> m a) -> m a
withProcessTerm_ :: (MonadTypedProcess m, HasCallStack) => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> m a) -> m a
waitExitCode :: (MonadTypedProcess m, HasCallStack) => Process stdin stdout stderr -> m ExitCode
waitExitCodeSTM :: Process stdin stdout stderr -> STM ExitCode
getExitCode :: (MonadTypedProcess m, HasCallStack) => Process stdin stdout stderr -> m (Maybe ExitCode)
getExitCodeSTM :: Process stdin stdout stderr -> STM (Maybe ExitCode)
checkExitCode :: (MonadTypedProcess m, HasCallStack) => Process stdin stdout stderr -> m ()
checkExitCodeSTM :: Process stdin stdout stderr -> STM ()
getStdin :: Process stdin stdout stderr -> stdin
getStdout :: Process stdin stdout stderr -> stdout
getStderr :: Process stdin stdout stderr -> stderr
data ExitCodeException = ExitCodeException {
- eceExitCode :: ExitCode
- eceProcessConfig :: ProcessConfig () () ()
- eceStdout :: ByteString
- eceStderr :: ByteString
}
data ByteStringOutputException = ByteStringOutputException SomeException (ProcessConfig () () ())
data ExitCode
- = ExitSuccess
- | ExitFailure Int
data StdStream
- = Inherit
- | UseHandle Handle
- | CreatePipe
- | NoStream
unsafeProcessHandle :: Process stdin stdout stderr -> ProcessHandle

Effect

class Monad m => MonadTypedProcess (m :: Type -> Type) where Source #

Effect for launching processes. API largely follows typed-process.

Since: 0.1

Methods

runProcess Source #

Arguments

:: HasCallStack
=> ProcessConfig stdin stdout stderr	.
-> m ExitCode

Lifted runProcess.

Since: 0.1

readProcess Source #

Arguments

:: HasCallStack
=> ProcessConfig stdin stdoutIgnored stderrIgnored	.
-> m (ExitCode, ByteString, ByteString)

Lifted readProcess.

Since: 0.1

readProcessStdout Source #

Arguments

:: HasCallStack
=> ProcessConfig stdin stdoutIgnored stderr	.
-> m (ExitCode, ByteString)

Lifted readProcessStdout.

Since: 0.1

readProcessStderr Source #

Arguments

:: HasCallStack
=> ProcessConfig stdin stdout stderrIgnored	.
-> m (ExitCode, ByteString)

Lifted readProcessStderr.

Since: 0.1

readProcessInterleaved Source #

Arguments

:: HasCallStack
=> ProcessConfig stdin stdoutIgnored stderrIgnored	.
-> m (ExitCode, ByteString)

Lifted readProcessInterleaved.

Since: 0.1

withProcessWait Source #

Arguments

:: HasCallStack
=> ProcessConfig stdin stdout stderr	.
-> (Process stdin stdout stderr -> m a)
-> m a

Lifted withProcessWait.

Since: 0.1

withProcessTerm Source #

Arguments

:: HasCallStack
=> ProcessConfig stdin stdout stderr	.
-> (Process stdin stdout stderr -> m a)
-> m a

Lifted withProcessTerm.

Since: 0.1

startProcess Source #

Arguments

:: HasCallStack
=> ProcessConfig stdin stdout stderr	.
-> m (Process stdin stdout stderr)

Lifted startProcess.

Since: 0.1

stopProcess Source #

Arguments

:: HasCallStack
=> Process stdin stdout stderr	.
-> m ()

Lifted stopProcess.

Since: 0.1

runProcess_ Source #

Arguments

:: HasCallStack
=> ProcessConfig stdin stdout stderr	.
-> m ()

Lifted runProcess_.

Since: 0.1

readProcess_ Source #

Arguments

:: HasCallStack
=> ProcessConfig stdin stdoutIgnored stderrIgnored	.
-> m (ByteString, ByteString)

Lifted readProcess_.

Since: 0.1

readProcessStdout_ Source #

Arguments

:: HasCallStack
=> ProcessConfig stdin stdoutIgnored stderr	.
-> m ByteString

Lifted readProcessStdout_.

Since: 0.1

readProcessStderr_ Source #

Arguments

:: HasCallStack
=> ProcessConfig stdin stdout stderrIgnored	.
-> m ByteString

Lifted readProcessStderr_.

Since: 0.1

readProcessInterleaved_ Source #

Arguments

:: HasCallStack
=> ProcessConfig stdin stdoutIgnored stderrIgnored	.
-> m ByteString

Lifted readProcessInterleaved_.

Since: 0.1

withProcessWait_ Source #

Arguments

:: HasCallStack
=> ProcessConfig stdin stdout stderr	.
-> (Process stdin stdout stderr -> m a)
-> m a

Lifted withProcessWait_.

Since: 0.1

withProcessTerm_ Source #

Arguments

:: HasCallStack
=> ProcessConfig stdin stdout stderr	.
-> (Process stdin stdout stderr -> m a)
-> m a

Lifted withProcessTerm_.

Since: 0.1

waitExitCode Source #

Arguments

:: HasCallStack
=> Process stdin stdout stderr	.
-> m ExitCode

Lifted waitExitCode.

Since: 0.1

getExitCode Source #

Arguments

:: HasCallStack
=> Process stdin stdout stderr	.
-> m (Maybe ExitCode)

Lifted getExitCode.

Since: 0.1

checkExitCode Source #

Arguments

:: HasCallStack
=> Process stdin stdout stderr	.
-> m ()

Lifted checkExitCode.

Since: 0.1

Instances

Instances details

MonadTypedProcess IO Source #	Since: 0.1
Instance details Defined in Effects.Process.Typed Methods runProcess :: HasCallStack => ProcessConfig stdin stdout stderr -> IO ExitCode Source # readProcess :: HasCallStack => ProcessConfig stdin stdoutIgnored stderrIgnored -> IO (ExitCode, ByteString, ByteString) Source # readProcessStdout :: HasCallStack => ProcessConfig stdin stdoutIgnored stderr -> IO (ExitCode, ByteString) Source # readProcessStderr :: HasCallStack => ProcessConfig stdin stdout stderrIgnored -> IO (ExitCode, ByteString) Source # readProcessInterleaved :: HasCallStack => ProcessConfig stdin stdoutIgnored stderrIgnored -> IO (ExitCode, ByteString) Source # withProcessWait :: HasCallStack => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> IO a) -> IO a Source # withProcessTerm :: HasCallStack => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> IO a) -> IO a Source # startProcess :: HasCallStack => ProcessConfig stdin stdout stderr -> IO (Process stdin stdout stderr) Source # stopProcess :: HasCallStack => Process stdin stdout stderr -> IO () Source # runProcess_ :: HasCallStack => ProcessConfig stdin stdout stderr -> IO () Source # readProcess_ :: HasCallStack => ProcessConfig stdin stdoutIgnored stderrIgnored -> IO (ByteString, ByteString) Source # readProcessStdout_ :: HasCallStack => ProcessConfig stdin stdoutIgnored stderr -> IO ByteString Source # readProcessStderr_ :: HasCallStack => ProcessConfig stdin stdout stderrIgnored -> IO ByteString Source # readProcessInterleaved_ :: HasCallStack => ProcessConfig stdin stdoutIgnored stderrIgnored -> IO ByteString Source # withProcessWait_ :: HasCallStack => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> IO a) -> IO a Source # withProcessTerm_ :: HasCallStack => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> IO a) -> IO a Source # waitExitCode :: HasCallStack => Process stdin stdout stderr -> IO ExitCode Source # getExitCode :: HasCallStack => Process stdin stdout stderr -> IO (Maybe ExitCode) Source # checkExitCode :: HasCallStack => Process stdin stdout stderr -> IO () Source #
MonadTypedProcess m => MonadTypedProcess (ReaderT env m) Source #	Since: 0.1
Instance details Defined in Effects.Process.Typed Methods runProcess :: HasCallStack => ProcessConfig stdin stdout stderr -> ReaderT env m ExitCode Source # readProcess :: HasCallStack => ProcessConfig stdin stdoutIgnored stderrIgnored -> ReaderT env m (ExitCode, ByteString, ByteString) Source # readProcessStdout :: HasCallStack => ProcessConfig stdin stdoutIgnored stderr -> ReaderT env m (ExitCode, ByteString) Source # readProcessStderr :: HasCallStack => ProcessConfig stdin stdout stderrIgnored -> ReaderT env m (ExitCode, ByteString) Source # readProcessInterleaved :: HasCallStack => ProcessConfig stdin stdoutIgnored stderrIgnored -> ReaderT env m (ExitCode, ByteString) Source # withProcessWait :: HasCallStack => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> ReaderT env m a) -> ReaderT env m a Source # withProcessTerm :: HasCallStack => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> ReaderT env m a) -> ReaderT env m a Source # startProcess :: HasCallStack => ProcessConfig stdin stdout stderr -> ReaderT env m (Process stdin stdout stderr) Source # stopProcess :: HasCallStack => Process stdin stdout stderr -> ReaderT env m () Source # runProcess_ :: HasCallStack => ProcessConfig stdin stdout stderr -> ReaderT env m () Source # readProcess_ :: HasCallStack => ProcessConfig stdin stdoutIgnored stderrIgnored -> ReaderT env m (ByteString, ByteString) Source # readProcessStdout_ :: HasCallStack => ProcessConfig stdin stdoutIgnored stderr -> ReaderT env m ByteString Source # readProcessStderr_ :: HasCallStack => ProcessConfig stdin stdout stderrIgnored -> ReaderT env m ByteString Source # readProcessInterleaved_ :: HasCallStack => ProcessConfig stdin stdoutIgnored stderrIgnored -> ReaderT env m ByteString Source # withProcessWait_ :: HasCallStack => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> ReaderT env m a) -> ReaderT env m a Source # withProcessTerm_ :: HasCallStack => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> ReaderT env m a) -> ReaderT env m a Source # waitExitCode :: HasCallStack => Process stdin stdout stderr -> ReaderT env m ExitCode Source # getExitCode :: HasCallStack => Process stdin stdout stderr -> ReaderT env m (Maybe ExitCode) Source # checkExitCode :: HasCallStack => Process stdin stdout stderr -> ReaderT env m () Source #

Types

data ProcessConfig stdin stdout stderr Source #

An abstract configuration for a process, which can then be launched into an actual running Process. Takes three type parameters, providing the types of standard input, standard output, and standard error, respectively.

There are three ways to construct a value of this type:

With the proc smart constructor, which takes a command name and a list of arguments.
With the shell smart constructor, which takes a shell string
With the IsString instance via OverloadedStrings. If you provide it a string with no spaces (e.g., "date"), it will treat it as a raw command with no arguments (e.g., proc "date" []). If it has spaces, it will use shell.

In all cases, the default for all three streams is to inherit the streams from the parent process. For other settings, see the setters below for default values.

Once you have a ProcessConfig you can launch a process from it using the functions in the section Launch a process.

Since: typed-process-0.1.0.0

Instances

Instances details

(stdin ~ (), stdout ~ (), stderr ~ ()) => IsString (ProcessConfig stdin stdout stderr)
Instance details Defined in System.Process.Typed.Internal Methods fromString :: String -> ProcessConfig stdin stdout stderr #
Show (ProcessConfig stdin stdout stderr)
Instance details Defined in System.Process.Typed.Internal Methods showsPrec :: Int -> ProcessConfig stdin stdout stderr -> ShowS # show :: ProcessConfig stdin stdout stderr -> String # showList :: [ProcessConfig stdin stdout stderr] -> ShowS #

data StreamSpec (streamType :: StreamType) a Source #

A specification for how to create one of the three standard child streams, stdin, stdout and stderr. A StreamSpec can be thought of as containing

A type safe version of StdStream from System.Process. This determines whether the stream should be inherited from the parent process, piped to or from a Handle, etc.
A means of accessing the stream as a value of type a
A cleanup action which will be run on the stream once the process terminates

To create a StreamSpec see the section Stream specs.

Since: typed-process-0.1.0.0

Instances

Instances details

Functor (StreamSpec streamType)
Instance details Defined in System.Process.Typed.Internal Methods fmap :: (a -> b) -> StreamSpec streamType a -> StreamSpec streamType b # (<$) :: a -> StreamSpec streamType b -> StreamSpec streamType a #
(streamType ~ 'STInput, res ~ ()) => IsString (StreamSpec streamType res)	This instance uses `byteStringInput` to convert a raw string into a stream of input for a child process. Since: typed-process-0.1.0.0
Instance details Defined in System.Process.Typed.Internal Methods fromString :: String -> StreamSpec streamType res #

data StreamType Source #

Whether a stream is an input stream or output stream. Note that this is from the perspective of the child process, so that a child's standard input stream is an STInput, even though the parent process will be writing to it.

Since: typed-process-0.1.0.0

data Process stdin stdout stderr Source #

A running process. The three type parameters provide the type of the standard input, standard output, and standard error streams.

To interact with a Process use the functions from the section Interact with a process.

Since: typed-process-0.1.0.0

Instances

Instances details

Show (Process stdin stdout stderr)
Instance details Defined in System.Process.Typed Methods showsPrec :: Int -> Process stdin stdout stderr -> ShowS # show :: Process stdin stdout stderr -> String # showList :: [Process stdin stdout stderr] -> ShowS #

ProcessConfig

proc :: FilePath -> [String] -> ProcessConfig () () () Source #

Create a ProcessConfig from the given command and arguments.

Since: typed-process-0.1.0.0

shell :: String -> ProcessConfig () () () Source #

Create a ProcessConfig from the given shell command.

Since: typed-process-0.1.0.0

Setters

setStdin Source #

Arguments

:: StreamSpec 'STInput stdin
-> ProcessConfig stdin0 stdout stderr
-> ProcessConfig stdin stdout stderr

Set the child's standard input stream to the given StreamSpec.

Default: inherit

Since: typed-process-0.1.0.0

setStdout Source #

Arguments

:: StreamSpec 'STOutput stdout
-> ProcessConfig stdin stdout0 stderr
-> ProcessConfig stdin stdout stderr

Set the child's standard output stream to the given StreamSpec.

Default: inherit

Since: typed-process-0.1.0.0

setStderr Source #

Arguments

:: StreamSpec 'STOutput stderr
-> ProcessConfig stdin stdout stderr0
-> ProcessConfig stdin stdout stderr

Set the child's standard error stream to the given StreamSpec.

Default: inherit

Since: typed-process-0.1.0.0

setWorkingDir Source #

Arguments

:: FilePath
-> ProcessConfig stdin stdout stderr
-> ProcessConfig stdin stdout stderr

Set the working directory of the child process.

Default: current process's working directory.

Since: typed-process-0.1.0.0

setWorkingDirInherit Source #

Arguments

:: ProcessConfig stdin stdout stderr
-> ProcessConfig stdin stdout stderr

Inherit the working directory from the parent process.

Since: typed-process-0.2.2.0

setEnv Source #

Arguments

:: [(String, String)]
-> ProcessConfig stdin stdout stderr
-> ProcessConfig stdin stdout stderr

Set the environment variables of the child process.

Default: current process's environment.

Since: typed-process-0.1.0.0

setEnvInherit Source #

Arguments

:: ProcessConfig stdin stdout stderr
-> ProcessConfig stdin stdout stderr

Inherit the environment variables from the parent process.

Since: typed-process-0.2.2.0

setCloseFds Source #

Arguments

:: Bool
-> ProcessConfig stdin stdout stderr
-> ProcessConfig stdin stdout stderr

Should we close all file descriptors besides stdin, stdout, and stderr? See close_fds for more information.

Default: False

Since: typed-process-0.1.0.0

setCreateGroup Source #

Arguments

:: Bool
-> ProcessConfig stdin stdout stderr
-> ProcessConfig stdin stdout stderr

Should we create a new process group?

Default: False

Since: typed-process-0.1.0.0

setDelegateCtlc Source #

Arguments

:: Bool
-> ProcessConfig stdin stdout stderr
-> ProcessConfig stdin stdout stderr

Delegate handling of Ctrl-C to the child. For more information, see delegate_ctlc.

Default: False

Since: typed-process-0.1.0.0

setDetachConsole Source #

Arguments

:: Bool
-> ProcessConfig stdin stdout stderr
-> ProcessConfig stdin stdout stderr

Detach console on Windows, see detach_console.

Default: False

Since: typed-process-0.1.0.0

setCreateNewConsole Source #

Arguments

:: Bool
-> ProcessConfig stdin stdout stderr
-> ProcessConfig stdin stdout stderr

Create new console on Windows, see create_new_console.

Default: False

Since: typed-process-0.1.0.0

setNewSession Source #

Arguments

:: Bool
-> ProcessConfig stdin stdout stderr
-> ProcessConfig stdin stdout stderr

Set a new session with the POSIX setsid syscall, does nothing on non-POSIX. See new_session.

Default: False

Since: typed-process-0.1.0.0

setChildGroup Source #

Arguments

:: GroupID
-> ProcessConfig stdin stdout stderr
-> ProcessConfig stdin stdout stderr

Set the child process's group ID with the POSIX setgid syscall, does nothing on non-POSIX. See child_group.

Default: False

Since: typed-process-0.1.0.0

setChildGroupInherit Source #

Arguments

:: ProcessConfig stdin stdout stderr
-> ProcessConfig stdin stdout stderr

Inherit the group from the parent process.

Since: typed-process-0.2.2.0

setChildUser Source #

Arguments

:: UserID
-> ProcessConfig stdin stdout stderr
-> ProcessConfig stdin stdout stderr

Set the child process's user ID with the POSIX setuid syscall, does nothing on non-POSIX. See child_user.

Default: False

Since: typed-process-0.1.0.0

setChildUserInherit Source #

Arguments

:: ProcessConfig stdin stdout stderr
-> ProcessConfig stdin stdout stderr

Inherit the user from the parent process.

Since: typed-process-0.2.2.0

Stream specs

Built-in stream specs

inherit :: forall (anyStreamType :: StreamType). StreamSpec anyStreamType () Source #

A stream spec which simply inherits the stream of the parent process.

Since: typed-process-0.1.0.0

nullStream :: forall (anyStreamType :: StreamType). StreamSpec anyStreamType () Source #

A stream spec which is empty when used for for input and discards output. Note this requires your platform's null device to be available when the process is started.

Since: typed-process-0.2.5.0

closed :: forall (anyStreamType :: StreamType). StreamSpec anyStreamType () Source #

A stream spec which will close the stream for the child process. You usually do not want to use this, as it will leave the corresponding file descriptor unassigned and hence available for re-use in the child process. Prefer nullStream unless you're certain you want this behavior.

Since: typed-process-0.1.0.0

byteStringInput :: ByteString -> StreamSpec 'STInput () Source #

An input stream spec which sets the input to the given ByteString. A separate thread will be forked to write the contents to the child process.

Since: typed-process-0.1.0.0

byteStringOutput :: StreamSpec 'STOutput (STM ByteString) Source #

Capture the output of a process in a ByteString.

This function will fork a separate thread to consume all input from the process, and will only make the results available when the underlying Handle is closed. As this is provided as an STM action, you can either check if the result is available, or block until it's ready.

In the event of any exception occurring when reading from the Handle, the STM action will throw a ByteStringOutputException.

Since: typed-process-0.1.0.0

createPipe :: forall (anyStreamType :: StreamType). StreamSpec anyStreamType Handle Source #

Create a new pipe between this process and the child, and return a Handle to communicate with the child.

Since: typed-process-0.1.0.0

useHandleOpen :: forall (anyStreamType :: StreamType). Handle -> StreamSpec anyStreamType () Source #

Use the provided Handle for the child process, and when the process exits, do not close it. This is useful if, for example, you want to have multiple processes write to the same log file sequentially.

Since: typed-process-0.1.0.0

useHandleClose :: forall (anyStreamType :: StreamType). Handle -> StreamSpec anyStreamType () Source #

Use the provided Handle for the child process, and when the process exits, close it. If you have no reason to keep the Handle open, you should use this over useHandleOpen.

Since: typed-process-0.1.0.0

Create your own stream spec

mkStreamSpec Source #

Arguments

:: forall a (streamType :: StreamType). StdStream
-> (ProcessConfig () () () -> Maybe Handle -> IO (a, IO ()))
-> StreamSpec streamType a

Create a new StreamSpec from the given StdStream and a helper function. This function:

Takes as input the raw Maybe Handle returned by the createProcess function. The handle will be Just Handle if the StdStream argument is CreatePipe and Nothing otherwise. See createProcess for more details.
Returns the actual stream value a, as well as a cleanup function to be run when calling stopProcess.

If making a StreamSpec with CreatePipe, prefer mkPipeStreamSpec, which encodes the invariant that a Handle is created.

Since: typed-process-0.1.0.0

mkPipeStreamSpec Source #

Arguments

:: forall a (streamType :: StreamType). (ProcessConfig () () () -> Handle -> IO (a, IO ()))
-> StreamSpec streamType a

Create a new CreatePipe StreamSpec from the given function. This function:

Takes as input the Handle returned by the createProcess function. See createProcess for more details.
Returns the actual stream value a, as well as a cleanup function to be run when calling stopProcess.

Since: typed-process-0.2.10.0

Launch a process

runProcess Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> ProcessConfig stdin stdout stderr	.
-> m ExitCode

Lifted runProcess.

Since: 0.1

readProcess Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> ProcessConfig stdin stdoutIgnored stderrIgnored	.
-> m (ExitCode, ByteString, ByteString)

Lifted readProcess.

Since: 0.1

readProcessStdout Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> ProcessConfig stdin stdoutIgnored stderr	.
-> m (ExitCode, ByteString)

Lifted readProcessStdout.

Since: 0.1

readProcessStderr Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> ProcessConfig stdin stdout stderrIgnored	.
-> m (ExitCode, ByteString)

Lifted readProcessStderr.

Since: 0.1

readProcessInterleaved Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> ProcessConfig stdin stdoutIgnored stderrIgnored	.
-> m (ExitCode, ByteString)

Lifted readProcessInterleaved.

Since: 0.1

withProcessWait Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> ProcessConfig stdin stdout stderr	.
-> (Process stdin stdout stderr -> m a)
-> m a

Lifted withProcessWait.

Since: 0.1

withProcessTerm Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> ProcessConfig stdin stdout stderr	.
-> (Process stdin stdout stderr -> m a)
-> m a

Lifted withProcessTerm.

Since: 0.1

startProcess Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> ProcessConfig stdin stdout stderr	.
-> m (Process stdin stdout stderr)

Lifted startProcess.

Since: 0.1

stopProcess Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> Process stdin stdout stderr	.
-> m ()

Lifted stopProcess.

Since: 0.1

Exception-throwing functions

runProcess_ Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> ProcessConfig stdin stdout stderr	.
-> m ()

Lifted runProcess_.

Since: 0.1

readProcess_ Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> ProcessConfig stdin stdoutIgnored stderrIgnored	.
-> m (ByteString, ByteString)

Lifted readProcess_.

Since: 0.1

readProcessStdout_ Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> ProcessConfig stdin stdoutIgnored stderr	.
-> m ByteString

Lifted readProcessStdout_.

Since: 0.1

readProcessStderr_ Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> ProcessConfig stdin stdout stderrIgnored	.
-> m ByteString

Lifted readProcessStderr_.

Since: 0.1

readProcessInterleaved_ Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> ProcessConfig stdin stdoutIgnored stderrIgnored	.
-> m ByteString

Lifted readProcessInterleaved_.

Since: 0.1

withProcessWait_ Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> ProcessConfig stdin stdout stderr	.
-> (Process stdin stdout stderr -> m a)
-> m a

Lifted withProcessWait_.

Since: 0.1

withProcessTerm_ Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> ProcessConfig stdin stdout stderr	.
-> (Process stdin stdout stderr -> m a)
-> m a

Lifted withProcessTerm_.

Since: 0.1

Interact with a process

Process exit code

waitExitCode Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> Process stdin stdout stderr	.
-> m ExitCode

Lifted waitExitCode.

Since: 0.1

waitExitCodeSTM :: Process stdin stdout stderr -> STM ExitCode Source #

Same as waitExitCode, but in STM.

Since: typed-process-0.1.0.0

getExitCode Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> Process stdin stdout stderr	.
-> m (Maybe ExitCode)

Lifted getExitCode.

Since: 0.1

getExitCodeSTM :: Process stdin stdout stderr -> STM (Maybe ExitCode) Source #

Same as getExitCode, but in STM.

Since: typed-process-0.1.0.0

checkExitCode Source #

Arguments

:: (MonadTypedProcess m, HasCallStack)
=> Process stdin stdout stderr	.
-> m ()

Lifted checkExitCode.

Since: 0.1

checkExitCodeSTM :: Process stdin stdout stderr -> STM () Source #

Same as checkExitCode, but in STM.

Since: typed-process-0.1.0.0

Process streams

getStdin :: Process stdin stdout stderr -> stdin Source #

Get the child's standard input stream value.

Since: typed-process-0.1.0.0

getStdout :: Process stdin stdout stderr -> stdout Source #

Get the child's standard output stream value.

Since: typed-process-0.1.0.0

getStderr :: Process stdin stdout stderr -> stderr Source #

Get the child's standard error stream value.

Since: typed-process-0.1.0.0

Exceptions

data ExitCodeException Source #

Exception thrown by checkExitCode in the event of a non-success exit code. Note that checkExitCode is called by other functions as well, like runProcess_ or readProcess_.

Note that several functions that throw an ExitCodeException intentionally do not populate eceStdout or eceStderr. This prevents unbounded memory usage for large stdout and stderrs.

Since: typed-process-0.1.0.0

Constructors

ExitCodeException
Fields eceExitCode :: ExitCode eceProcessConfig :: ProcessConfig () () () eceStdout :: ByteString eceStderr :: ByteString

Instances

Instances details

Exception ExitCodeException
Instance details Defined in System.Process.Typed.Internal Methods toException :: ExitCodeException -> SomeException # fromException :: SomeException -> Maybe ExitCodeException # displayException :: ExitCodeException -> String #
Show ExitCodeException
Instance details Defined in System.Process.Typed.Internal Methods showsPrec :: Int -> ExitCodeException -> ShowS # show :: ExitCodeException -> String # showList :: [ExitCodeException] -> ShowS #

data ByteStringOutputException Source #

Wrapper for when an exception is thrown when reading from a child process, used by byteStringOutput.

Since: typed-process-0.1.0.0

Constructors

ByteStringOutputException SomeException (ProcessConfig () () ())

Instances

Instances details

Exception ByteStringOutputException
Instance details Defined in System.Process.Typed.Internal Methods toException :: ByteStringOutputException -> SomeException # fromException :: SomeException -> Maybe ByteStringOutputException # displayException :: ByteStringOutputException -> String #
Show ByteStringOutputException
Instance details Defined in System.Process.Typed.Internal Methods showsPrec :: Int -> ByteStringOutputException -> ShowS # show :: ByteStringOutputException -> String # showList :: [ByteStringOutputException] -> ShowS #

Re-exports

data ExitCode #

Defines the exit codes that a program can return.

Constructors

ExitSuccess	indicates successful termination;
ExitFailure Int	indicates program failure with an exit code. The exact interpretation of the code is operating-system dependent. In particular, some values may be prohibited (e.g. 0 on a POSIX-compliant system).

Instances

Instances details

Exception ExitCode

Since: base-4.1.0.0

Instance details

Defined in GHC.IO.Exception

Methods

toException :: ExitCode -> SomeException #

fromException :: SomeException -> Maybe ExitCode #

displayException :: ExitCode -> String #

Generic ExitCode

Instance details

Defined in GHC.IO.Exception

Associated Types

type Rep ExitCode
Instance details Defined in GHC.IO.Exception type Rep ExitCode = D1 ('MetaData "ExitCode" "GHC.IO.Exception" "base" 'False) (C1 ('MetaCons "ExitSuccess" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ExitFailure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

Methods

from :: ExitCode -> Rep ExitCode x #

to :: Rep ExitCode x -> ExitCode #

Read ExitCode

Instance details

Defined in GHC.IO.Exception

Methods

readsPrec :: Int -> ReadS ExitCode #

readList :: ReadS [ExitCode] #

readPrec :: ReadPrec ExitCode #

readListPrec :: ReadPrec [ExitCode] #

Show ExitCode

Instance details

Defined in GHC.IO.Exception

Methods

showsPrec :: Int -> ExitCode -> ShowS #

show :: ExitCode -> String #

showList :: [ExitCode] -> ShowS #

NFData ExitCode

Since: deepseq-1.4.2.0

Instance details

Defined in Control.DeepSeq

Methods

rnf :: ExitCode -> () #

Eq ExitCode

Instance details

Defined in GHC.IO.Exception

Methods

(==) :: ExitCode -> ExitCode -> Bool #

(/=) :: ExitCode -> ExitCode -> Bool #

Ord ExitCode

Instance details

Defined in GHC.IO.Exception

Methods

compare :: ExitCode -> ExitCode -> Ordering #

(<) :: ExitCode -> ExitCode -> Bool #

(<=) :: ExitCode -> ExitCode -> Bool #

(>) :: ExitCode -> ExitCode -> Bool #

(>=) :: ExitCode -> ExitCode -> Bool #

max :: ExitCode -> ExitCode -> ExitCode #

min :: ExitCode -> ExitCode -> ExitCode #

type Rep ExitCode

Instance details

Defined in GHC.IO.Exception

type Rep ExitCode = D1 ('MetaData "ExitCode" "GHC.IO.Exception" "base" 'False) (C1 ('MetaCons "ExitSuccess" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ExitFailure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

data StdStream #

Constructors

Inherit	Inherit Handle from parent
UseHandle Handle	Use the supplied Handle
CreatePipe	Create a new pipe. The returned `Handle` will use the default encoding and newline translation mode (just like `Handle`s created by `openFile`).
NoStream	Close the stream's file descriptor without passing a Handle. On POSIX systems this may lead to strange behavior in the child process because attempting to read or write after the file has been closed throws an error. This should only be used with child processes that don't use the file descriptor at all. If you wish to ignore the child process's output you should either create a pipe and drain it manually or pass a `Handle` that writes to `/dev/null`.

Instances

Instances details

Show StdStream
Instance details Defined in System.Process.Common Methods showsPrec :: Int -> StdStream -> ShowS # show :: StdStream -> String # showList :: [StdStream] -> ShowS #
Eq StdStream
Instance details Defined in System.Process.Common Methods (==) :: StdStream -> StdStream -> Bool # (/=) :: StdStream -> StdStream -> Bool #

Unsafe functions

unsafeProcessHandle :: Process stdin stdout stderr -> ProcessHandle Source #

Take ProcessHandle out of the Process. This method is needed in cases one need to use low level functions from the process package. Use cases for this method are:

Send a special signal to the process.
Terminate the process group instead of terminating single process.
Use platform specific API on the underlying process.

This method is considered unsafe because the actions it performs on the underlying process may overlap with the functionality that typed-process provides. For example the user should not call waitForProcess on the process handle as either waitForProcess or stopProcess will lock. Additionally, even if process was terminated by the terminateProcess or by sending signal, stopProcess should be called either way in order to cleanup resources allocated by the typed-process.

Since: typed-process-0.1.1