phobos ~master (2023-10-10T16:11:09Z)

execute

std process

Executes the given program or shell command and returns its exit code and output.

execute and executeShell start a new process using spawnProcess and spawnShell, respectively, and wait for the process to complete before returning. The functions capture what the child process prints to both its standard output and standard error streams, and return this together with its exit code.

auto dmd = execute(["dmd", "myapp.d"]);
if (dmd.status != 0) writeln("Compilation failed:\n", dmd.output);

auto ls = executeShell("ls -l");
if (ls.status != 0) writeln("Failed to retrieve file listing");
else writeln(ls.output);

The args/program/command, env and config parameters are forwarded straight to the underlying spawn functions, and we refer to their documentation for details.

  1. auto execute(const(char[])[] args, string[string] env, Config config, size_t maxOutput, const(char)[] workDir)
  2. auto execute(const(char)[] program, string[string] env, Config config, size_t maxOutput, const(char)[] workDir)
    @safe
    auto
    execute
    (
    scope const(char)[] program
    ,
    const string[string] env = null
    ,
    Config config = Config.none
    ,
    size_t maxOutput = size_t.max
    ,
    scope const(char)[] workDir = null
    )

Parameters

program const(char)[]

The program name, without command-line arguments. (See spawnProcess for details.)

env string[string]

Additional environment variables for the child process. (See spawnProcess for details.)

config Config

Flags that control process creation. See Config for an overview of available flags, and note that the retainStd... flags have no effect in this function.

maxOutput size_t

The maximum number of bytes of output that should be captured.

workDir const(char)[]

The working directory for the new process. By default the child process inherits the parent's working directory.

Return Value

Type: auto

An std.typecons.Tuple!(int, "status", string, "output").

POSIX specific

If the process is terminated by a signal, the status field of the return value will contain a negative number whose absolute value is the signal number. (See wait for details.)

Throws

ProcessException on failure to start the process.
std.stdio.StdioException on failure to capture output.

Meta

Source

See Implementation

std process classesenumsfunctionspropertiesstructs

Page generated by adrdox