lens-process-0.3.0.0: Optics for system processes

Copyright2019 Emily Pillmore
LicenseBSD
MaintainerEmily Pillmore <emilypi@cohomolo.gy>
StabilityExperimental
PortabilityTypeFamilies, Rank2Types
Safe HaskellSafe
LanguageHaskell2010

System.Process.Lens.Optics

Contents

Description

Just the (classy) optics

Synopsis

Prisms

_ShellCommand :: Prism' CmdSpec String Source #

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]) Source #

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"]

_Inherit :: Prism' StdStream StdStream Source #

A Prism' into the Inherit structure of a StdStream

Examples:

>>> _Inherit # CreatePipe
Inherit

_UseHandle :: Prism' StdStream Handle Source #

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

Examples:

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

_CreatePipe :: Prism' StdStream StdStream Source #

A Prism' into the CreatePipe structure of a StdStream

Examples:

>>> _CreatePipe # Inherit
CreatePipe

_NoStream :: Prism' StdStream StdStream Source #

A prism into the NoStream structure of a StdStream

Examples:

>>> _NoStream # CreatePipe
NoStream

Isos

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

An iso between the ProcessHandler data and its product representation

Traversals

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

Traversal' into the arguments of a command

Examples:

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

Lenses

cmdspec_ :: Lens' CreateProcess CmdSpec Source #

Lens into the cmdspec entry of the CreateProcess record

cwd_ :: Lens' CreateProcess (Maybe FilePath) Source #

Lens into the cwd entry of the CreateProcess record

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

Lens into the env entry of the CreateProcess record

stdin_ :: Lens' CreateProcess StdStream Source #

Lens into the std_in entry of the CreateProcess record

stdout_ :: Lens' CreateProcess StdStream Source #

Lens into the std_out entry of the CreateProcess record

stderr_ :: Lens' CreateProcess StdStream Source #

Lens into the std_err entry of the CreateProcess record

closefds :: Lens' CreateProcess Bool Source #

Lens into the close_fds entry of the CreateProcess record

creategroup :: Lens' CreateProcess Bool Source #

Lens into the create_group entry of the CreateProcess record

delegatectlc :: Lens' CreateProcess Bool Source #

Lens into the delegate_ctlc entry of the CreateProcess record

newsession :: Lens' CreateProcess Bool Source #

Lens into the new_session entry of the CreateProcess record

detachconsole :: Lens' CreateProcess Bool Source #

Lens into the detach_console entry of the CreateProcess record

createnewconsole :: Lens' CreateProcess Bool Source #

Lens into the create_new_console entry of the CreateProcess record

childgroup :: Lens' CreateProcess (Maybe CGid) Source #

Lens into the child_group entry of the CreateProcess record

childuser :: Lens' CreateProcess (Maybe CUid) Source #

Lens into the child_user entry of the CreateProcess record

useprocessjobs :: Lens' CreateProcess Bool Source #

Lens into the use_process_jobs entry of the CreateProcess record

hstdin :: Lens' ProcessHandler (Maybe Handle) Source #

A lens into the stdin handle if requested

hstdout :: Lens' ProcessHandler (Maybe Handle) Source #

A lens into the stdout handle if requested

hstderr :: Lens' ProcessHandler (Maybe Handle) Source #

A lens into the stderr handle if requested

hhandle :: Lens' ProcessHandler ProcessHandle Source #

A lens into the process handle

Classy Prisms

class IsRaw a where Source #

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"

Minimal complete definition

_Raw

Methods

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

Instances
IsRaw CmdSpec Source # 
Instance details

Defined in System.Process.Lens.CmdSpec

Methods

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

class IsShell a where Source #

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"

Minimal complete definition

_Shell

Methods

_Shell :: Prism' a String Source #

Instances
IsShell CmdSpec Source # 
Instance details

Defined in System.Process.Lens.CmdSpec

Methods

_Shell :: Prism' CmdSpec String Source #

class IsInherit a where Source #

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

Minimal complete definition

_Inherits

Methods

_Inherits :: Prism' a StdStream Source #

Instances
IsInherit StdStream Source # 
Instance details

Defined in System.Process.Lens.StdStream

class IsUseHandle a where Source #

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

Minimal complete definition

_UsesHandle

Methods

_UsesHandle :: Prism' a Handle Source #

Instances
IsUseHandle StdStream Source # 
Instance details

Defined in System.Process.Lens.StdStream

class IsCreatePipe a where Source #

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

Minimal complete definition

_CreatesPipe

Methods

_CreatesPipe :: Prism' a StdStream Source #

Instances
IsCreatePipe StdStream Source # 
Instance details

Defined in System.Process.Lens.StdStream

class IsNoStream a where Source #

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.

Minimal complete definition

_NoStreams

Methods

_NoStreams :: Prism' a StdStream Source #

Instances
IsNoStream StdStream Source # 
Instance details

Defined in System.Process.Lens.StdStream

Classy Lenses

class HasStdin a where Source #

Classy lens for types with a stdin

Minimal complete definition

_Stdin

Methods

_Stdin :: Lens' a StdStream Source #

class HasStdout a where Source #

Classy lens for types with a stdout

Minimal complete definition

_Stdout

Methods

_Stdout :: Lens' a StdStream Source #

class HasStderr a where Source #

Classy lens for types with a stderr

Minimal complete definition

_Stderr

Methods

_Stderr :: Lens' a StdStream Source #