System.Process.Lens

This module provides all of the optical exports, as well ask any associated combinators. For just the optics, see Optics, or if you are in need of something lighter weight, just for working with a CreateProcess in terms of getters and setters, see https://hackage.haskell.org/package/microlens

For more information on usage and how to work with lenses, see http://github.com/ekmett/lens/wiki and the tests for example uses. You can also ask questions on Freenode in the #haskell-lens channel.

Data

data ProcessHandler

A convenient handler for the output of a createProcess call. This data containes 4 components:

1. a handle to stdin if it was requested
2. a handle to stdout if it was requested
3. a handle to stderr if it was requested
4. a process handle, containing a pid lock, information regarding ctcl-c delegation, and closed/open handle status info.

Constructors

ProcessHandler

Fields

• _hstdin :: Maybe Handle
• _hstdout :: Maybe Handle
• _hstderr :: Maybe Handle
• _hhandle :: ProcessHandle

Prisms

_ShellCommand :: Prism' CmdSpec String

A prism into the ShellCommand case of a CmdSpec

Examples:

>>> _ShellCommand # "ls -l"
ShellCommand "ls -l"

>>> ShellCommand "ls -l" ^? _ShellCommand
Just "ls -l"

>>> RawCommand "/bin/ls" ["-l"] ^? _ShellCommand
Nothing

_RawCommand :: Prism' CmdSpec (FilePath, [String])

A prism into the RawCommand case of a CmdSpec

Examples:

>>> RawCommand "/bin/ls" ["-l"] ^? _RawCommand
Just ("/bin/ls",["-l"])

>>> RawCommand "/bin/ls" ["-l"] ^? _ShellCommand
Nothing

>>> RawCommand "/bin/ls" ["-l"] ^. _RawCommand . _1
"/bin/ls"

>>> RawCommand "/bin/ls" ["-l"] ^. _RawCommand . _2
["-l"]

arguments :: IsRaw a => Traversal' a [String]

Traversal' into the arguments of a command

Examples:

>>> RawCommand "/bin/ls" ["-l"] ^. arguments
["-l"]

_Inherit :: Prism' StdStream StdStream

A prism into the Inherit structure of a StdStream

Examples:

>>> _Inherit # CreatePipe
Inherit

_UseHandle :: Prism' StdStream Handle

A prism into the UseHandle structure's Handle for a StdStream

Examples:

>>> _UseHandle # System.stdin
UseHandle {handle: <stdin>}

_CreatePipe :: Prism' StdStream StdStream

A prism into the CreatePipe structure of a StdStream

Examples:

>>> _CreatePipe # Inherit
CreatePipe

_NoStream :: Prism' StdStream StdStream

A prism into the NoStream structure of a StdStream

Examples:

>>> _NoStream # CreatePipe
NoStream

Isos

_Handler :: Iso' ProcessHandler (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle)

An iso between the ProcessHandler data and its product representation

Lenses

cmdspec_ :: Lens' CreateProcess CmdSpec

Lens into the cmdspec entry of the CreateProcess record

cwd_ :: Lens' CreateProcess (Maybe FilePath)

Lens into the cwd entry of the CreateProcess record

env_ :: Lens' CreateProcess (Maybe [(String, String)])

Lens into the env entry of the CreateProcess record

stdin_ :: Lens' CreateProcess StdStream

Lens into the std_in entry of the CreateProcess record

stdout_ :: Lens' CreateProcess StdStream

Lens into the std_out entry of the CreateProcess record

stderr_ :: Lens' CreateProcess StdStream

Lens into the std_err entry of the CreateProcess record

closefds :: Lens' CreateProcess Bool

Lens into the close_fds entry of the CreateProcess record

creategroup :: Lens' CreateProcess Bool

Lens into the create_group entry of the CreateProcess record

delegatectlc :: Lens' CreateProcess Bool

Lens into the delegate_ctlc entry of the CreateProcess record

detachconsole :: Lens' CreateProcess Bool

Lens into the detach_console entry of the CreateProcess record

createnewconsole :: Lens' CreateProcess Bool

Lens into the create_new_console entry of the CreateProcess record

newsession :: Lens' CreateProcess Bool

Lens into the new_session entry of the CreateProcess record

childgroup :: Lens' CreateProcess (Maybe CGid)

Lens into the child_group entry of the CreateProcess record

childuser :: Lens' CreateProcess (Maybe CUid)

Lens into the child_user entry of the CreateProcess record

useprocessjobs :: Lens' CreateProcess Bool

Lens into the use_process_jobs entry of the CreateProcess record

hstdin :: Lens' ProcessHandler (Maybe Handle)

A lens into the stdin handle if requested

hstdout :: Lens' ProcessHandler (Maybe Handle)

A lens into the stdout handle if requested

hstderr :: Lens' ProcessHandler (Maybe Handle)

A lens into the stderr handle if requested

hhandle :: Lens' ProcessHandler ProcessHandle

A lens into the process handle

Classes

class IsRaw a where

Classy prism into the raw command of a CmdSpec

Examples:

>>> f :: IsRaw a => a -> Maybe FilePath; f = preview (_Raw . _1)
>>> f $ _RawCommand # ("/bin/ls", ["ls -l"])
Just "/bin/ls"

Methods

_Raw :: Prism' a (FilePath, [String])

Instances

IsRaw CmdSpec

Defined in System.Process.Lens.CommandSpec

Methods

_Raw :: Prism' CmdSpec (FilePath, [String])

class IsShell a where

Classy prism into the shell command of a CmdSpec

Examples:

>>> f :: IsShell a => a -> Maybe String; f = preview _Shell
>>> f $ _ShellCommand # "ls -l"
Just "ls -l"

Methods

_Shell :: Prism' a String

Instances

IsShell CmdSpec

Defined in System.Process.Lens.CommandSpec

Methods

_Shell :: Prism' CmdSpec String

class IsInherit a where

Class constraint proving a type has a prism into an Inherit structure. Any StdStream will have a prism into Inherit - it is just an overwrite to Inherit

Methods

_Inherits :: Prism' a StdStream

Instances

IsInherit StdStream

Defined in System.Process.Lens.StdStream

Methods

_Inherits :: Prism' StdStream StdStream

class IsUseHandle a where

Class constraint proving a type has a prism into a Handle via a UseHandle structure.

Methods

_UsesHandle :: Prism' a Handle

Instances

IsUseHandle StdStream

Defined in System.Process.Lens.StdStream

Methods

_UsesHandle :: Prism' StdStream Handle

class IsCreatePipe a where

Class constraint proving a type has a prism into a Handle via a UseHandle structure. Any StdStream will have a prism into CreatePipe - it is just an overwrite to CreatePipe

Methods

_CreatesPipe :: Prism' a StdStream

Instances

IsCreatePipe StdStream

Defined in System.Process.Lens.StdStream

Methods

_CreatesPipe :: Prism' StdStream StdStream

class IsNoStream a where

Class constraint proving a type has a prism into a Handle via a UseHandle structure. Any StdStream will have a prism into NoStream - it is just an overwrite to NoStream.

Methods

_NoStreams :: Prism' a StdStream

Instances

IsNoStream StdStream

Defined in System.Process.Lens.StdStream

Methods

_NoStreams :: Prism' StdStream StdStream

class HasStdin a where

Classy lens for types with a stdin

Methods

_Stdin :: Lens' a StdStream

Instances

HasStdin CreateProcess

Defined in System.Process.Lens.CreateProcess

Methods

_Stdin :: Lens' CreateProcess StdStream

HasStdin StdStream

Defined in System.Process.Lens.CreateProcess

Methods

_Stdin :: Lens' StdStream StdStream

class HasStdout a where

Classy lens for types with a stdout

Methods

_Stdout :: Lens' a StdStream

Instances

HasStdout CreateProcess

Defined in System.Process.Lens.CreateProcess

Methods

_Stdout :: Lens' CreateProcess StdStream

HasStdout StdStream

Defined in System.Process.Lens.CreateProcess

Methods

_Stdout :: Lens' StdStream StdStream

class HasStderr a where

Classy lens for types with a stderr

Methods

_Stderr :: Lens' a StdStream

Instances

HasStderr CreateProcess

Defined in System.Process.Lens.CreateProcess

Methods

_Stderr :: Lens' CreateProcess StdStream

HasStderr StdStream

Defined in System.Process.Lens.CreateProcess

Methods

_Stderr :: Lens' StdStream StdStream

Combinators

inheriting :: IsInherit a => Lens' a StdStream -> a -> a

Given a lens into a StdStream, overwrite to Inherit so that the stream inherits from its parent process

Examples:

>>> inheriting ($) CreatePipe
Inherit

piping :: IsCreatePipe a => Lens' a StdStream -> a -> a

Given a lens into a StdStream, overwrite to CreatePipe.

Examples:

>>> piping ($) NoStream
CreatePipe

handling :: IsUseHandle a => Lens' a StdStream -> Handle -> a -> a

Given a lens into a StdStream and a handle, set the handle using UseHandle. Note that this is the only really interesting case for anything with a lens into a handle inculding StdStream.

Examples:

>>> handling ($) System.stdin $ UseHandle System.stdout
UseHandle {handle: <stdin>}

>>> handling ($) System.stdin NoStream
NoStream

>>> handling ($) System.stdin Inherit
Inherit

nostreaming :: IsNoStream a => Lens' a StdStream -> a -> a

Given a lens into a StdStream, set to NoStream

Examples:

>>> nostreaming ($) Inherit
NoStream

arguing :: IsRaw a => String -> a -> a

Append an argument to the argument list of a RawCommand

Examples:

>>> arguing "-h" $ RawCommand "/bin/ls" ["-l"]
RawCommand "/bin/ls" ["-l","-h"]

>>> arguing "-h" (RawCommand "/bin/ls" ["-l"]) ^. arguments
["-l","-h"]

rawOf :: IsRaw a => FilePath -> [String] -> a

Lift a FilePath and list of arguments into a type via RawCommand with a prism into the command

Examples:

>>> rawOf @CmdSpec "/bin/ls" ["-l"]
RawCommand "/bin/ls" ["-l"]

shellOf :: IsShell a => String -> a

Lift a String into a type via ShellCommand with a prism into the

Examples:

>>> shellOf @CmdSpec "ls"
ShellCommand "ls"

usehandleOf :: IsUseHandle a => Handle -> a

Inject a handle into something with a prism into the handle

Examples:

>>> usehandleOf @StdStream System.stdin
UseHandle {handle: <stdin>}