Struct InteractionSpec 

pub struct InteractionSpec {
    pub key: String,
    pub case_ref: CaseRef,
    pub kind: InteractionKind,
    pub blocking: bool,
    pub payload: InteractionPayload,
    pub expires_in: Option<Duration>,
    pub text_resolution: TextResolutionPolicy,
    pub confirms_risk: RiskClass,
    pub binds_to_revision: bool,
}

What a reducer or workflow asks the engine to create (spec §13.3, I6).

Fields

key: String

Stable key within a turn/plan (e.g. "select_target:acts[1]"). Two specs with the same key describe the same interaction.

case_ref: CaseRef

Case the interaction belongs to; its revision is the bound revision.

kind: InteractionKind

Shape.

blocking: bool

Whether it owns unqualified answers for the case (I5).

payload: InteractionPayload

Content.

expires_in: Option<Duration>

Time to live, if any.

text_resolution: TextResolutionPolicy

Whether typed text may resolve it.

confirms_risk: RiskClass

Highest risk class of the commands an answer to this card authorizes.

The default is RiskClass::Irreversible, so a card that forgets to declare it is treated as consequential and can never be resolved from typed text (spec §13.2 rule 8, §15.7).

binds_to_revision: bool

true when the interaction is invalidated by a case revision change.

Implementations

impl InteractionSpec

pub fn new( key: impl Into<String>, case_ref: CaseRef, kind: InteractionKind, payload: InteractionPayload, ) -> InteractionSpec

Builds a blocking, revision-bound spec with Never text resolution and the conservative RiskClass::Irreversible confirmation risk.

pub fn with_confirms_risk(self, risk: RiskClass) -> InteractionSpec

Declares the highest risk class an answer authorizes.

pub fn validate(&self) -> Result<(), InteractionSpecError>

Checks that the card can be answered and that its text-resolution policy is allowed for what it confirms.

Beyond InteractionPayload::validate_for, any policy other than TextResolutionPolicy::Never is refused when the card authorizes commands above RiskClass::ReversibleLowRisk or is one of the authorizing kinds (InteractionKind::authorizes_commands): a confirmation inferred from prose is not a confirmation.

pub fn non_blocking(self) -> InteractionSpec

Marks the spec non-blocking.

pub fn with_text_resolution( self, policy: TextResolutionPolicy, ) -> InteractionSpec

Sets the text resolution policy.

pub fn expires_in(self, ttl: Duration) -> InteractionSpec

Sets the time to live.

pub fn revision_independent(self) -> InteractionSpec

Makes the interaction survive revision changes.

Trait Implementations

impl Clone for InteractionSpec

fn clone(&self) -> InteractionSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InteractionSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InteractionSpec

fn deserialize<__D>( __deserializer: __D, ) -> Result<InteractionSpec, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for InteractionSpec

impl PartialEq for InteractionSpec

fn eq(&self, other: &InteractionSpec) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for InteractionSpec

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InteractionSpec