Safe Haskell	Safe-Inferred
Language	Haskell2010

Control.Process.CmdSpec

Synopsis

data CmdSpec
- = ShellCommand String
- | RawCommand FilePath [String]
class GetCmdSpec a where
- getCmdSpec :: Getter a CmdSpec
class GetCmdSpec a => HasCmdSpec a where
- cmdSpec :: Lens' a CmdSpec
- shellCommand :: Traversal' a String
- rawCommand :: Traversal' a (FilePath, [String])
- rawCommandExe :: Traversal' a FilePath
- rawCommandArgumentList :: Traversal' a [String]
- rawCommandArguments :: Traversal' a String
class ReviewCmdSpec a where
- reviewCmdSpec :: Review a CmdSpec
class ReviewCmdSpec a => AsCmdSpec a where
- _CmdSpec :: Prism' a CmdSpec
- _ShellCommand :: Prism' a String
- _RawCommand :: Prism' a (FilePath, [String])
- _RawCommandExe :: Traversal' a FilePath
- _RawCommandArgumentList :: Traversal' a [String]
- _RawCommandArguments :: Traversal' a String

Documentation

data CmdSpec #

Constructors

ShellCommand String

A command line to execute using the shell

RawCommand FilePath [String]

The name of an executable with a list of arguments

The FilePath argument names the executable, and is interpreted according to the platform's standard policy for searching for executables. Specifically:

on Unix systems the execvp(3) semantics is used, where if the executable filename does not contain a slash (/) then the PATH environment variable is searched for the executable.
on Windows systems the Win32 CreateProcess semantics is used. Briefly: if the filename does not contain a path, then the directory containing the parent executable is searched, followed by the current directory, then some standard locations, and finally the current PATH. An .exe extension is added if the filename does not already have an extension. For full details see the documentation for the Windows SearchPath API.

Windows does not have a mechanism for passing multiple arguments. When using RawCommand on Windows, the command line is serialised into a string, with arguments quoted separately. Command line parsing is up individual programs, so the default behaviour may not work for some programs. If you are not getting the desired results, construct the command line yourself and use ShellCommand.

Instances

Instances details

IsString CmdSpec	construct a `ShellCommand` from a string literal Since: process-1.2.1.0
Instance details Defined in System.Process.Common Methods fromString :: String -> CmdSpec #
Show CmdSpec
Instance details Defined in System.Process.Common Methods showsPrec :: Int -> CmdSpec -> ShowS # show :: CmdSpec -> String # showList :: [CmdSpec] -> ShowS #
AsCmdSpec CmdSpec Source #	`>>>` `preview _ShellCommand (ShellCommand "ls -la")`Just "ls -la" `>>>` `preview _ShellCommand (RawCommand "ls" ["-la"])`Nothing `>>>` `preview _RawCommand (RawCommand "ls" ["-la"])`Just ("ls",["-la"]) `>>>` `preview _RawCommand (ShellCommand "ls -la")`Nothing `>>>` `review _ShellCommand "echo hello" :: CmdSpec`ShellCommand "echo hello" `>>>` `review _RawCommand ("/bin/ls", ["-la"]) :: CmdSpec`RawCommand "/bin/ls" ["-la"]
Instance details Defined in Control.Process.CmdSpec Methods _CmdSpec :: Prism' CmdSpec CmdSpec Source # _ShellCommand :: Prism' CmdSpec String Source # _RawCommand :: Prism' CmdSpec (FilePath, [String]) Source # _RawCommandExe :: Traversal' CmdSpec FilePath Source # _RawCommandArgumentList :: Traversal' CmdSpec [String] Source # _RawCommandArguments :: Traversal' CmdSpec String Source #
GetCmdSpec CmdSpec Source #	`>>>` `view getCmdSpec (ShellCommand "ls -la")`ShellCommand "ls -la"
Instance details Defined in Control.Process.CmdSpec Methods getCmdSpec :: Getter CmdSpec CmdSpec Source #
HasCmdSpec CmdSpec Source #	`>>>` `view cmdSpec (ShellCommand "ls")`ShellCommand "ls" `>>>` `set cmdSpec (RawCommand "echo" ["hi"]) (ShellCommand "ls")`RawCommand "echo" ["hi"]
Instance details Defined in Control.Process.CmdSpec Methods cmdSpec :: Lens' CmdSpec CmdSpec Source # shellCommand :: Traversal' CmdSpec String Source # rawCommand :: Traversal' CmdSpec (FilePath, [String]) Source # rawCommandExe :: Traversal' CmdSpec FilePath Source # rawCommandArgumentList :: Traversal' CmdSpec [String] Source # rawCommandArguments :: Traversal' CmdSpec String Source #
ReviewCmdSpec CmdSpec Source #	`>>>` `review reviewCmdSpec (ShellCommand "ls") :: CmdSpec`ShellCommand "ls"
Instance details Defined in Control.Process.CmdSpec Methods reviewCmdSpec :: Review CmdSpec CmdSpec Source #
Eq CmdSpec
Instance details Defined in System.Process.Common Methods (==) :: CmdSpec -> CmdSpec -> Bool # (/=) :: CmdSpec -> CmdSpec -> Bool #

class GetCmdSpec a where Source #

Type class for values that can be viewed as a CmdSpec.

>>> view getCmdSpec (ShellCommand "ls -la")
ShellCommand "ls -la"

Methods

getCmdSpec :: Getter a CmdSpec Source #

Instances

Instances details

GetCmdSpec CmdSpec Source #	`>>>` `view getCmdSpec (ShellCommand "ls -la")`ShellCommand "ls -la"
Instance details Defined in Control.Process.CmdSpec Methods getCmdSpec :: Getter CmdSpec CmdSpec Source #
GetCmdSpec CreateProcess Source #	`>>>` `import System.Process (proc)``>>>` `view getCmdSpec (proc "echo" ["hello"])`RawCommand "echo" ["hello"]
Instance details Defined in Control.Process.CmdSpec Methods getCmdSpec :: Getter CreateProcess CmdSpec Source #

class GetCmdSpec a => HasCmdSpec a where Source #

Type class for values with a lens into a CmdSpec.

>>> view cmdSpec (ShellCommand "ls -la")
ShellCommand "ls -la"

Minimal complete definition

cmdSpec

Methods

cmdSpec :: Lens' a CmdSpec Source #

shellCommand :: Traversal' a String Source #

rawCommand :: Traversal' a (FilePath, [String]) Source #

rawCommandExe :: Traversal' a FilePath Source #

rawCommandArgumentList :: Traversal' a [String] Source #

rawCommandArguments :: Traversal' a String Source #

Instances

Instances details

HasCmdSpec CmdSpec Source #	`>>>` `view cmdSpec (ShellCommand "ls")`ShellCommand "ls" `>>>` `set cmdSpec (RawCommand "echo" ["hi"]) (ShellCommand "ls")`RawCommand "echo" ["hi"]
Instance details Defined in Control.Process.CmdSpec Methods cmdSpec :: Lens' CmdSpec CmdSpec Source # shellCommand :: Traversal' CmdSpec String Source # rawCommand :: Traversal' CmdSpec (FilePath, [String]) Source # rawCommandExe :: Traversal' CmdSpec FilePath Source # rawCommandArgumentList :: Traversal' CmdSpec [String] Source # rawCommandArguments :: Traversal' CmdSpec String Source #
HasCmdSpec CreateProcess Source #	`>>>` `import System.Process (proc)``>>>` `view cmdSpec (proc "echo" ["hello"])`RawCommand "echo" ["hello"]
Instance details Defined in Control.Process.CmdSpec Methods cmdSpec :: Lens' CreateProcess CmdSpec Source # shellCommand :: Traversal' CreateProcess String Source # rawCommand :: Traversal' CreateProcess (FilePath, [String]) Source # rawCommandExe :: Traversal' CreateProcess FilePath Source # rawCommandArgumentList :: Traversal' CreateProcess [String] Source # rawCommandArguments :: Traversal' CreateProcess String Source #

class ReviewCmdSpec a where Source #

Type class for values that can be constructed from a CmdSpec.

>>> review reviewCmdSpec (ShellCommand "ls") :: CmdSpec
ShellCommand "ls"

Methods

reviewCmdSpec :: Review a CmdSpec Source #

Instances

Instances details

ReviewCmdSpec CmdSpec Source #	`>>>` `review reviewCmdSpec (ShellCommand "ls") :: CmdSpec`ShellCommand "ls"
Instance details Defined in Control.Process.CmdSpec Methods reviewCmdSpec :: Review CmdSpec CmdSpec Source #

class ReviewCmdSpec a => AsCmdSpec a where Source #

Type class for values with a prism into a CmdSpec.

>>> preview _CmdSpec (ShellCommand "ls -la")
Just (ShellCommand "ls -la")

Minimal complete definition

_CmdSpec

Methods

_CmdSpec :: Prism' a CmdSpec Source #

_ShellCommand :: Prism' a String Source #

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

_RawCommandExe :: Traversal' a FilePath Source #

_RawCommandArgumentList :: Traversal' a [String] Source #

_RawCommandArguments :: Traversal' a String Source #

Instances

Instances details

AsCmdSpec CmdSpec Source #

>>> preview _ShellCommand (ShellCommand "ls -la")
Just "ls -la"
>>> preview _ShellCommand (RawCommand "ls" ["-la"])
Nothing
>>> preview _RawCommand (RawCommand "ls" ["-la"])
Just ("ls",["-la"])
>>> preview _RawCommand (ShellCommand "ls -la")
Nothing
>>> review _ShellCommand "echo hello" :: CmdSpec
ShellCommand "echo hello"
>>> review _RawCommand ("/bin/ls", ["-la"]) :: CmdSpec
RawCommand "/bin/ls" ["-la"]

Instance details

Defined in Control.Process.CmdSpec

Methods

_CmdSpec :: Prism' CmdSpec CmdSpec Source #

_ShellCommand :: Prism' CmdSpec String Source #

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

_RawCommandExe :: Traversal' CmdSpec FilePath Source #

_RawCommandArgumentList :: Traversal' CmdSpec [String] Source #

_RawCommandArguments :: Traversal' CmdSpec String Source #