Skip to main content

InteractionSpec

Struct InteractionSpec 

Source
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,
}
Expand description

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§

Source§

impl InteractionSpec

Source

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

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

Source

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

Declares the highest risk class an answer authorizes.

Source

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.

Source

pub fn non_blocking(self) -> Self

Marks the spec non-blocking.

Source

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

Sets the text resolution policy.

Source

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

Sets the time to live.

Source

pub fn revision_independent(self) -> Self

Makes the interaction survive revision changes.

Trait Implementations§

Source§

impl Clone for InteractionSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InteractionSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for InteractionSpec

Source§

impl PartialEq for InteractionSpec

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for InteractionSpec

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for InteractionSpec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.