OutputModule

PackageAxial.Process

Summary

NameSignatureSynopsis
captureOutput.capture Retains all output bytes and their decoded text view.
captureTailOutput.captureTail maximumRetains only the final maximum number of bytes.
consoleOutput.console Forwards redirected bytes through the host console streams.
inheritHandlesOutput.inheritHandles Gives the child the host handle directly; this channel cannot also be observed or teed.
discardOutput.discard Drains and discards output.
fileOutput.file pathWrites output to a truncating file.
appendFileOutput.appendFile pathWrites output to an appending file.
callbackOutput.callback writeSends exact byte chunks to an asynchronous backpressured callback.
teeOutput.tee targetsSends every byte chunk to each target in order.
streamOutput.stream targetAdapts a writable .NET stream into an output target.
textWriterOutput.textWriter encoding targetDecodes output incrementally into a .NET text writer.

capture

Output.capture
Member
Retains all output bytes and their decoded text view.

Returns

OutputTarget

captureTail

Output.captureTail maximum
Member
Retains only the final maximum number of bytes.

Parameters

NameTypeDescription
maximumint

Returns

OutputTarget

console

Output.console
Member
Forwards redirected bytes through the host console streams.

Returns

OutputTarget

inheritHandles

Output.inheritHandles
Member
Gives the child the host handle directly; this channel cannot also be observed or teed.

Returns

OutputTarget

discard

Output.discard
Member
Drains and discards output.

Returns

OutputTarget

file

Output.file path
Member
Writes output to a truncating file.

Parameters

NameTypeDescription
pathstring

Returns

OutputTarget

appendFile

Output.appendFile path
Member
Writes output to an appending file.

Parameters

NameTypeDescription
pathstring

Returns

OutputTarget

callback

Output.callback write
Member
Sends exact byte chunks to an asynchronous backpressured callback.

Parameters

NameTypeDescription
writebyte array -> Async<unit>

Returns

OutputTarget

tee

Output.tee targets
Member
Sends every byte chunk to each target in order.

Parameters

NameTypeDescription
targetsOutputTarget seq

Returns

OutputTarget

stream

Output.stream target
Member
Adapts a writable .NET stream into an output target.

Parameters

NameTypeDescription
targetStream

Returns

OutputTarget

textWriter

Output.textWriter encoding target
Member
Decodes output incrementally into a .NET text writer.

Parameters

NameTypeDescription
encodingEncoding
targetTextWriter

Returns

OutputTarget