Skip to main content

Module actionability

Module actionability 

Source
Expand description

Provenance-conditional checks and actionable outcomes (spec 033): the definition 2 actionability member and the wire types of judgment 2’s actions, causes, remediations and questions.

Who can act on an outcome is computed from its causes; an author may move it away from the caller, never toward it (spec 033, I-2). Nothing here is a permission: addressed_to and a remediation say who can act and how, and a caller-addressed outcome authorizes nothing (spec 001, 3.2).

Structs§

Action
Who can act on an outcome or notice, how, why, and whether retrying the same request can succeed (3.5.2). Every member is always written.
Actionability
The definition 2 member (spec 033, 3.1.1). Each list may be empty.
AddressOverride
CheckDecl
A provenance-conditional check (3.2.2).
CheckRecord
One check’s evidence record (3.4.8).
ConstraintGroup
A named group of checks a relax consequence switches off (3.3.3).
ContinuationInputs
The canonical inputs of a continuation digest (3.7.4), in field order.
NeedsInput
The needs_input outcome (3.7).
OnFail
PlanActionability
The plan 3 member: the static causes and party of every check branch and policy site (3.8.3).
QuestionDecl
A declared, literal question template (3.7.3).
Refusal
One refusing check of a refused outcome (3.5.1).
RemediationCall
RemediationDecl
A declared remediation (3.6.3).
RemediationParam
StaticBranch
StaticCheck
StaticSite
A policy site that can produce an action (rule:<id>, handler:<n>).

Enums§

Address
Where an outcome is addressed: computed from its causes (when omitted), or an override toward a party less able to act (3.5.3).
Cause
One cause of an outcome or notice (3.5.2).
CauseProvenance
The provenance an input cause records (3.5.2).
CheckStatus
A check’s status in evidence 2 (3.4.8).
Consequence
What a failed check does (3.3). refuse, abstain and escalate are terminal; the others are field-level.
DefaultConsequence
A check’s default: the string none, or a consequence.
Origin
Who registered a backend (3.9): upstream unless the host implements it.
Override
none, or the party an author moved the outcome to and why.
OverrideBasis
How an override came about (3.5.2).
Party
Who can act on an outcome (3.5.2), ordered from most to least able to act on it themselves: the combination of parties is the greatest.
Remediation
A remediation as an action carries it: none, or a code and its canonical parameters (3.6.1).
RemediationUse
A use of a declared or built-in remediation: its code alone, or its code with parameters (3.6.3).
RemediationValue
A scalar or list value in a remediation’s parameters: the subset of OutValue (spec 002) a remediation can carry, in the same wire form.

Constants§

BUILTIN_REMEDIATIONS
Built-in remediation codes, never redeclared (3.6.2).
CALLER_CONTROLLABLE
The classes a host may declare caller-controlled (3.2.1).
CONTINUATION_TAG
The tag of a continuation digest.

Functions§

is_code
A code of [a-z][a-z0-9_]{0,63} (3.3.1, 3.5.3, 3.6.1).

Type Aliases§

Question
A question as a needs_input outcome carries it: the declared template, byte-identical (3.7.3).