osproc

nimony/lib/std/osproc.nim

The std/osproc module implements an advanced facility for executing OS processes and process communication.

This is the Nimony port. Compared to the upstream Nim module the POSIX path uses posix_spawn on illumos and fork + execve elsewhere. On illumos, launch errors are reported synchronously as OSError rather than as a child exiting with status 127. The timeout path of waitForExit uses a busy-wait with nanosleep.

See also:

type FileHandle = int32
OS-level file descriptor.

type ProcessOption = enum
  poEchoCmd = (0, "poEchoCmd")
  poUsePath = (1, "poUsePath")
  poEvalCommand = (2, "poEvalCommand")
  poStdErrToStdOut = (3, "poStdErrToStdOut")
  poParentStreams = (4, "poParentStreams")
  poInteractive = (5, "poInteractive")
  poDaemon = (6, "poDaemon")

func dollar`.ProcessOption(e: ProcessOption): string
type Process = ref ProcessObj
Represents an operating system process.
proc processID(p: ref ProcessObj): int64
Returns p's process ID.
proc inputHandle(p: ref ProcessObj): int32
Returns p's input file handle for writing to.
proc outputHandle(p: ref ProcessObj): int32
Returns p's output file handle for reading from.
proc errorHandle(p: ref ProcessObj): int32
Returns p's error file handle for reading from.
proc startProcess(command: string; workingDir: string; args: openArray[string]; env: ref StringTableObj; options: set[ProcessOption]): ref ProcessObj
proc close(p: ref ProcessObj)
proc suspend(p: ref ProcessObj)
proc resume(p: ref ProcessObj)
proc terminate(p: ref ProcessObj)
proc kill(p: ref ProcessObj)
proc running(p: ref ProcessObj): bool
proc waitForExit(p: ref ProcessObj; timeout: int64): int64
proc peekExitCode(p: ref ProcessObj): int64
proc inputStream(p: ref ProcessObj): ref StreamObj
proc outputStream(p: ref ProcessObj): ref StreamObj
proc errorStream(p: ref ProcessObj): ref StreamObj
proc execCmd(command: string): int64
Executes command and returns its error code.
iterator lines(p: ref ProcessObj; keepNewLines: bool): string
Iterates line-by-line over the process's stdout until EOF, then waits for the process to exit.
proc readLines(p: ref ProcessObj): tuple[seq[string], int64]
Reads all stdout lines and returns them together with the exit code.
proc execProcess(command: string; workingDir: string; args: openArray[string]; env: ref StringTableObj; options: set[ProcessOption]): string
Executes command and returns its combined stdout as a string.
proc execCmdEx(command: string; options: set[ProcessOption]; env: ref StringTableObj; workingDir: string; input: string): tuple[string, int64]
Runs command, returning its output and exit code.
proc execProcesses(cmds: openArray[string]; options: set[ProcessOption]; n: int64): int64
Executes cmds with at most n in flight concurrently. Returns the maximum absolute exit code. beforeRunEvent / afterRunEvent hooks are omitted here; subscribe to them upstream if you need the callbacks.