CancellableFinalizer

public class CancellableFinalizer

Cancellable finalizer returned from catch. Use finally to specify a code block that executes when the promise chain resolves.

  • The CancelContext associated with this finalizer

    Declaration

    Swift

    public let cancelContext: CancelContext
    Show on GitHub

  • finally is the same as ensure, but it is not chainable

    Declaration

    Swift

    @discardableResult
public func finally(on: DispatchQueue? = conf.Q.return, flags: DispatchWorkItemFlags? = nil, _ body: @escaping () -> Void) -> CancelContext
    Show on GitHub

  • Cancel all members of the promise chain and their associated asynchronous operations.

    Declaration

    Swift

    public func cancel(error: Error? = nil)

    Parameters

    error

    Specifies the cancellation error to use for the cancel operation, defaults to PMKError.cancelled
    Show on GitHub

  • True if all members of the promise chain have been successfully cancelled, false otherwise.

    Declaration

    Swift

    public var isCancelled: Bool { get }
    Show on GitHub

  • True if cancel has been called on the CancelContext associated with this promise, false otherwise. cancelAttempted will be true if cancel is called on any promise in the chain.

    Declaration

    Swift

    public var cancelAttempted: Bool { get }
    Show on GitHub

  • The cancellation error generated when the promise is cancelled, or nil if not cancelled.

    Declaration

    Swift

    public var cancelledError: Error? { get }
    Show on GitHub