process/io.matthewnelson.kmp.process

Package-level declarations

Types

actual class AsyncWriteStream : BufferedWriteStream

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

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.

Blocking

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.

BufferedWriteStream

expect sealed class BufferedWriteStream

actual sealed class BufferedWriteStream : BufferedOutputStream

actual sealed class BufferedWriteStream

InternalProcessApi

@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.

Output

class Output

Output results from Process.Builder.output

OutputFeed

fun interface OutputFeed

A callback for obtaining stdout and stderr output.

Process

abstract class Process : OutputFeed.Handler

A Process.

ProcessException

class ProcessException : RuntimeException

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

ReadBuffer

@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.

Signal

enum Signal : Enum<Signal>

The signal to send when Process.destroy is called.

Stdio

sealed class Stdio

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

Functions

changeDir

fun Process.Builder.changeDir(directory: File?): Process.Builder

Changes the working directory of the spawned process.

detached

fun Process.Builder.detached(enable: Boolean): Process.Builder

Configures the detached option for spawn.

shell

fun Process.Builder.shell(enable: Boolean): Process.Builder

Configures the shell option for spawn and spawnSync

fun Process.Builder.shell(shell: String): Process.Builder

Configures the shell option for spawn and spawnSync.

usePosixSpawn

fun Process.Builder.usePosixSpawn(use: Boolean): Process.Builder

By default, posix_spawn and posix_spawnp are always preferred when spawning processes, given that the necessary API availability is present (e.g. Android Native requires a device API of 28+, or 34+ if changing the process' working directory via changeDir). If API availability is not present, then an alternative implementation using fork and execve is fallen back to. This option allows you to skip over posix_spawn, regardless of its API availability, and go directly to the alternative implementation using fork and execve.

windowsHide

fun Process.Builder.windowsHide(enable: Boolean): Process.Builder

Configures the windowsHide option for spawn and spawnSync

windowsVerbatimArguments

fun Process.Builder.windowsVerbatimArguments(enable: Boolean): Process.Builder

Configures the windowsVerbatimArguments option for spawn and spawnSync