DeferredModule

Flow-native helpers for one-shot typed coordination.

Summary

NameSignatureSynopsis
Operations
makeDeferred.make ()Creates an empty deferred value.
awaitDeferred.await (Deferred signal)Waits for the deferred outcome, preserving success, typed failure, defect, or interruption.
completeDeferred.complete exit (Deferred signal)Attempts to complete the deferred value with a full outcome.
succeedDeferred.succeed value deferredAttempts to complete the deferred value successfully.
failDeferred.fail error deferredAttempts to complete the deferred value with a typed failure.
dieDeferred.die error deferredAttempts to complete the deferred value with a defect.
interruptDeferred.interrupt deferredAttempts to complete the deferred value as interrupted.

Operations

kind:member

make

Deferred.make ()
Member
Creates an empty deferred value.

Parameters

NameTypeDescription
unit

Returns

Flow<'env, 'error, Deferred<'error, 'value>>
kind:member

await

Deferred.await (Deferred signal)
Member
Waits for the deferred outcome, preserving success, typed failure, defect, or interruption.

Parameters

NameTypeDescription
Deferred signalDeferred<'error, 'value>

Returns

Flow<'env, 'error, 'value>
kind:member

complete

Deferred.complete exit (Deferred signal)
Member
Attempts to complete the deferred value with a full outcome.

Parameters

NameTypeDescription
exitExit<'value, 'error>
Deferred signalDeferred<'error, 'value>

Returns

Flow<'env, 'workflowError, bool>
kind:member

succeed

Deferred.succeed value deferred
Member
Attempts to complete the deferred value successfully.

Parameters

NameTypeDescription
value'value
deferredDeferred<'error, 'value>

Returns

Flow<'env, 'workflowError, bool>
kind:member

fail

Deferred.fail error deferred
Member
Attempts to complete the deferred value with a typed failure.

Parameters

NameTypeDescription
error'error
deferredDeferred<'error, 'value>

Returns

Flow<'env, 'workflowError, bool>
kind:member

die

Deferred.die error deferred
Member
Attempts to complete the deferred value with a defect.

Parameters

NameTypeDescription
errorexn
deferredDeferred<'error, 'value>

Returns

Flow<'env, 'workflowError, bool>
kind:member

interrupt

Deferred.interrupt deferred
Member
Attempts to complete the deferred value as interrupted.

Parameters

NameTypeDescription
deferredDeferred<'error, 'value>

Returns

Flow<'env, 'workflowError, bool>