InputModule

PackageAxial.Process

Summary

NameSignatureSynopsis
Operations
emptyInput.empty Supplies no bytes and closes stdin.
textInput.text valueSupplies encoded text incrementally when execution begins.
bytesInput.bytes valueSupplies exact bytes when execution begins.
fileInput.file pathStreams bytes from a file when execution begins.
inheritHandlesInput.inheritHandles Gives the root process the host's stdin handle directly, so programs that prompt on the console (such as ssh asking for a password) can read it.
flowStreamInput.flowStream sourceConsumes a cold byte stream with backpressure.
streamInput.stream sourceAdapts a .NET stream into a backpressured input source.

Operations

kind:member

empty

Input.empty
Member
Supplies no bytes and closes stdin.

Returns

InputSource
kind:member

text

Input.text value
Member
Supplies encoded text incrementally when execution begins.

Parameters

NameTypeDescription
valuestring

Returns

InputSource
kind:member

bytes

Input.bytes value
Member
Supplies exact bytes when execution begins.

Parameters

NameTypeDescription
valuebyte array

Returns

InputSource
kind:member

file

Input.file path
Member
Streams bytes from a file when execution begins.

Parameters

NameTypeDescription
pathstring

Returns

InputSource
kind:member

inheritHandles

Input.inheritHandles
Member
Gives the root process the host's stdin handle directly, so programs that prompt on the console (such as `ssh` asking for a password) can read it. Stdin is not redirected, so the child, not Axial, decides when it ends. Pipe-connected stages still receive redirected stdin.

Returns

InputSource
kind:member

flowStream

Input.flowStream source
Member
Consumes a cold byte stream with backpressure. Close over dependencies with Flow.localEnv (or Layer.provide) before building the spec.

Parameters

NameTypeDescription
sourceFlowStream<unit, 'error, byte array>

Returns

InputSource
kind:member

stream

Input.stream source
Member
Adapts a .NET stream into a backpressured input source.

Parameters

NameTypeDescription
sourceStream

Returns

InputSource