Deferred22

Constructors

makeconstCreates a new Deferred.

Models

DeferredinterfaceA Deferred represents an asynchronous variable that can be set exactly once, with the ability for an arbitrary number of fibers to suspend (by calling Deferred.await) and automatically resume when the variable is set.

Guards

isDeferredconstChecks whether a value is a Deferred.

Getters

isDoneconstReturns true if this Deferred has already been completed with a value or an error, false otherwise.isDoneUnsafeconstReturns whether this Deferred has already been completed synchronously.pollfunctionReturns the current completion effect as an Option.

Completion

completeconstRuns the supplied Effect and attempts to complete the Deferred with its memoized result.completeWithconstAttempts to complete the Deferred with the specified effect directly.dieconstAttempts to complete the Deferred with a defect.dieSyncconstComputes a defect when the returned effect is run, then attempts to complete the Deferred with that defect.doneconstCompletes the Deferred with the specified Exit value, which will be propagated to all fibers waiting on the value of the Deferred.failconstAttempts to complete the Deferred with the specified error.failCauseconstAttempts to complete the Deferred with the specified Cause.failCauseSyncconstComputes a Cause when the returned effect is run, then attempts to complete the Deferred with that cause.failSyncconstComputes an error when the returned effect is run, then attempts to complete the Deferred with that error.interruptconstAttempts to complete the Deferred with interruption by the current fiber.interruptWithconstAttempts to complete the Deferred with interruption by the specified FiberId.succeedconstAttempts to complete the Deferred with the specified value.syncconstComputes a value when the returned effect is run, then attempts to complete the Deferred with that value.

Synchronization Utilities

intoconstRuns an Effect and attempts to complete a Deferred with the effect's result.

Unsafe

doneUnsafeconstAttempts to complete the Deferred synchronously with the specified completion effect.makeUnsafeconstCreates an empty Deferred synchronously outside the Effect runtime.