ksubprocess/ksubprocess

Package-level declarations

Types

CommunicateResult

data class CommunicateResult(val exitCode: Int, val output: String, val errors: String)

Result tuple of Process.communicate().

expect object Environment : Map<String, String>

The current process environment.

actual object Environment : AbstractMap<String, String> , Map<String, String>

actual object Environment : AbstractMap<String, String> , Map<String, String>

actual object Environment : Map<String, String>

actual object Environment : AbstractMap<String, String> , Map<String, String>

EnvironmentBuilder

class EnvironmentBuilder(init: Map<String, String> = Environment) : AbstractMutableMap<String, String>

A mutable copy of the current environment.

ExecArgumentsBuilder

class ExecArgumentsBuilder : ProcessArgumentBuilder

Builder for the exec method.

expect class Process(args: ProcessArguments)

A child process.

actual class Process(val args: ProcessArguments)

actual class Process(val args: ProcessArguments)

actual class Process(val args: ProcessArguments)

actual class Process(val args: ProcessArguments)

ProcessArgumentBuilder

open class ProcessArgumentBuilder

Mutable builder for process arguments and environment.

ProcessArguments

class ProcessArguments(arguments: Iterable<String>, val workingDirectory: String? = null, environment: Map<String, String>? = null, val stdin: Redirect = Redirect.Pipe, val stdout: Redirect = Redirect.Pipe, val stderr: Redirect = Redirect.Pipe)

Immutable process launch arguments.

ProcessConfigException

class ProcessConfigException(message: String? = null, cause: Throwable? = null) : ProcessException

Indicates a problem with the process setup.

ProcessException

open class ProcessException(message: String? = null, cause: Throwable? = null) : Exception

General subprocess exception.

ProcessExitException

class ProcessExitException(val result: CommunicateResult) : ProcessException

Indicates a process that didn't exit cleanly.

sealed class Redirect

Subprocess pipe redirection settings.

Properties

executablePaths

val executablePaths: List<String>

Functions

suspend fun Process.communicate(input: String = "", timeout: Duration? = null, killTimeout: Duration? = null): CommunicateResult

Communicate with the process and wait for its termination.

suspend fun exec(builder: ExecArgumentsBuilder.() -> Unit): CommunicateResult

Launch a process, communicate with it and check the result.

fun findExecutable(name: String): String?

Locate the named executable on the system PATH.

inline fun Process(builder: ProcessArgumentBuilder.() -> Unit): Process

Launch process using builder.

ProcessArguments

inline fun ProcessArguments(builder: ProcessArgumentBuilder.() -> Unit): ProcessArguments

Create ProcessArguments using builder.