Jidoka.Cancellation (Jidoka v0.9.0)

Typed evidence that an asynchronous Jidoka request was cancelled.

Cancellation is request-scoped runtime data. It is not a turn snapshot and it does not imply that an external side effect was rolled back.

Summary

t()

token()

Opaque request-scoped cancellation signal used by the runtime.

new(attrs)

Builds typed cancellation evidence.

new!(attrs)

Builds typed cancellation evidence or raises.

Returns true when a runtime context or token has a cancellation request.

schema()

Returns the schema for typed cancellation evidence.

@type t() :: %Jidoka.Cancellation{
  cancelled_at_ms: integer(),
  forced?: boolean(),
  reason: :cancelled,
  request_id: binary()
}

@opaque token()

Opaque request-scoped cancellation signal used by the runtime.

@spec new(keyword() | map()) :: {:ok, t()} | {:error, term()}

Builds typed cancellation evidence.

@spec new!(keyword() | map()) :: t()

Builds typed cancellation evidence or raises.

@spec requested?(Jidoka.Context.t() | token()) :: boolean()

Returns true when a runtime context or token has a cancellation request.

@spec schema() :: Zoi.schema()

Returns the schema for typed cancellation evidence.