Endorphin.Core


CancellationCapability<'T>

Namespace: Endorphin.Core
Parent Module: CancellationCapability

Cancellation capability with generic options which must be specified at cancellation.

Constructors

ConstructorDescription
new()
Signature: unit -> CancellationCapability<'T>

CompiledName: .ctor

Instance members

Instance memberDescription
Cancel(options)
Signature: options:'T -> unit

Cancels the cancellation capability after setting the specified cancellation options. Can only be called once.

IsCancellationRequested
Signature: bool

Checks if cancellation has already been requested.

CompiledName: get_IsCancellationRequested

Options
Signature: 'T

Returns the options argument specifed at cancellation. Throws an exception if cancellation has not taken place.

CompiledName: get_Options

Token
Signature: CancellationToken

Returns the cancellation token.

CompiledName: get_Token

Fork me on GitHub