Axial

ProcessErrorUnion

PackageAxial.Process
A recoverable process startup, cancellation, stage, or I/O failure.

Specification

Kind
Union
Members
12
Examples
0
describeSignature
ProcessError.describe error
exitCodeSignature
ProcessError.exitCode _arg1
IsIoFailedSignature
this.IsIoFailed
IsTimedOutSignature
this.IsTimedOut
IsStartFailedSignature
this.IsStartFailed

Summary

NameSignatureSynopsis
Union cases
IsIoFailedthis.IsIoFailedNo description available.
IsTimedOutthis.IsTimedOutNo description available.
IsStartFailedthis.IsStartFailedNo description available.
IsStageFailedthis.IsStageFailedNo description available.
IsCanceledthis.IsCanceledNo description available.
StartFailedStartFailed ProcessStartFailureNo description available.
TimedOutTimedOut ProcessTimeoutNo description available.
CanceledCanceled ProcessCancellationNo description available.
StageFailedStageFailed StageFailureNo description available.
IoFailedIoFailed ProcessIoFailureNo description available.
Operations
describeProcessError.describe errorFormats a process error with stage-aware diagnostic context.
exitCodeProcessError.exitCode _arg1Returns a suitable host exit code for a process failure.

Union cases

kind:member

IsIoFailed

this.IsIoFailed
Member

Returns

bool
kind:member

IsTimedOut

this.IsTimedOut
Member

Returns

bool
kind:member

IsStartFailed

this.IsStartFailed
Member

Returns

bool
kind:member

IsStageFailed

this.IsStageFailed
Member

Returns

bool
kind:member

IsCanceled

this.IsCanceled
Member

Returns

bool
kind:member

StartFailed

StartFailed ProcessStartFailure
Member

Parameters

NameTypeDescription
ItemProcessStartFailure

Returns

unit
kind:member

TimedOut

TimedOut ProcessTimeout
Member

Parameters

NameTypeDescription
ItemProcessTimeout

Returns

unit
kind:member

Canceled

Canceled ProcessCancellation
Member

Parameters

NameTypeDescription
ItemProcessCancellation

Returns

unit
kind:member

StageFailed

StageFailed StageFailure
Member

Parameters

NameTypeDescription
ItemStageFailure

Returns

unit
kind:member

IoFailed

IoFailed ProcessIoFailure
Member

Parameters

NameTypeDescription
ItemProcessIoFailure

Returns

unit

Operations

kind:member

describe

ProcessError.describe error
Member
Formats a process error with stage-aware diagnostic context. Example: error |> ProcessError.describe

Parameters

NameTypeDescription
errorProcessError

Returns

string
kind:member

exitCode

ProcessError.exitCode _arg1
Member
Returns a suitable host exit code for a process failure. Example: Environment.ExitCode <- ProcessError.exitCode error

Parameters

NameTypeDescription
_arg1ProcessError

Returns

int