Package-level declarations

Types

Link copied to clipboard

A stream to write to. On Jvm & Native, blocking APIs are available via BufferedWriteStream.

expect class AsyncWriteStream

A stream to write to. On Jvm & Native, blocking APIs are available via io.matthewnelson.kmp.process.BufferedWriteStream.

actual class AsyncWriteStream

A stream to write to.

Link copied to clipboard
actual sealed class Blocking

Extended by OutputFeed.Handler (which is extended by Process) in order to provide blocking APIs for Jvm & Native.

expect sealed class Blocking

Extended by OutputFeed.Handler (which is extended by Process) in order to provide blocking APIs for Jvm & Native.

actual sealed class Blocking

Extended by OutputFeed.Handler (which is extended by Process) in order to provide blocking APIs for Jvm & Native.

Link copied to clipboard
expect sealed class BufferedWriteStream(stream: WriteStream)
actual sealed class BufferedWriteStream(stream: WriteStream)
Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])
annotation class InternalProcessApi

Denotes an api as internal and subject to change at any time.

Link copied to clipboard
class Output

Output results from Process.Builder.output

Link copied to clipboard
fun interface OutputFeed

A callback for obtaining stdout and stderr output.

Link copied to clipboard
abstract class Process : OutputFeed.Handler

A Process.

Link copied to clipboard
class ProcessException : RuntimeException

Represents an error that has been encountered during the runtime of a Process.

Link copied to clipboard
@JvmInline
actual value class ReadBuffer

For internal usage only.

expect value class ReadBuffer

For internal usage only.

actual value class ReadBuffer

For internal usage only.

Link copied to clipboard
enum Signal : Enum<Signal>

The signal to send when Process.destroy is called.

Link copied to clipboard
sealed class Stdio

Standard input/output stream types for Process stdin, stdout, and stderr.

Functions

Link copied to clipboard

Changes the working directory of the spawned process.

Link copied to clipboard

Configures the detached option for spawn.

Link copied to clipboard
fun Process.Builder.shell(enable: Boolean): Process.Builder

Configures the shell option for spawn and spawnSync

Configures the shell option for spawn and spawnSync.

Link copied to clipboard

Configures the windowsHide option for spawn and spawnSync

Link copied to clipboard

Configures the windowsVerbatimArguments option for spawn and spawnSync