Skip to main content

InteractionEngine

Struct InteractionEngine 

Source
pub struct InteractionEngine { /* private fields */ }
Expand description

Reads, writes and settles persisted interactions (spec §15).

Implementations§

Source§

impl InteractionEngine

Source

pub fn new(store: Arc<dyn InteractionStore>, config: InteractionConfig) -> Self

Builds an engine over store.

Source

pub fn with_observer(self, observer: Arc<dyn Observer>) -> Self

Sends this stage’s signals to observer (spec §26.2).

Orchestrator sets it from its own observer when it is built, so a card settled out of band — the §15.7 free-text channel, an operator tool, a reconciliation job — is counted on the same series as one a turn settled.

Source

pub const fn config(&self) -> &InteractionConfig

The interaction configuration in force.

Source

pub async fn create( &self, spec: InteractionSpec, account: &AccountId, conversation: ConversationId, turn_id: TurnId, now: DateTime<Utc>, ) -> Result<(Interaction, Vec<InteractionId>), InteractionError>

Materializes one specification and writes it (spec §15.5, §15.6).

A blocking card replaces the case’s current blocking occupant and invalidates it; a non-blocking one is inserted next to whatever is there. The identifier is derived from the turn and the specification key, so a replay writes the same card rather than a duplicate.

§Errors
Source

pub async fn persist( &self, specs: &[InteractionSpec], account: &AccountId, conversation: ConversationId, turn_id: TurnId, now: DateTime<Utc>, ) -> PersistedInteractions

Writes every specification, stopping at the first failure.

Nothing here is best effort in the sense of “carry on and hope”: the first failure stops the loop and is reported, precisely so the caller cannot describe cards that are not there.

Source

pub async fn accept( &self, context: ResponseContext<'_>, response: &InteractionResponse, ) -> Result<ResponseAdmission, InteractionError>

Validates a client answer and takes the card into Resolving (spec §15.5, §23 step C).

current_revision is the revision the case is actually at, read fresh: a card bound to an older one is Stale whatever the client echoed.

§Errors

InteractionError::Rejected carrying the §15.5 rejection. An identifier of another tenant is InteractionRejection::NotFound, exactly like one that never existed (spec §25.4).

Source

pub async fn settle( &self, account: &AccountId, id: &InteractionId, outcome: ResolutionOutcome, ) -> Result<InteractionRecord, InteractionError>

Settles a Resolving card.

§Errors

InteractionError::NotPersisted when the store refused, and InteractionError::Rejected with NotFound when the card is not there.

Source

pub async fn mark_resolved( &self, account: &AccountId, id: &InteractionId, event_ids: Vec<EventId>, ) -> Result<InteractionRecord, InteractionError>

Marks a card Resolved — only legitimate once the command its answer authorized has committed, which is why the events are required (§15.5).

§Errors

See Self::settle.

Source

pub async fn mark_failed( &self, account: &AccountId, id: &InteractionId, code: impl Into<String>, ) -> Result<InteractionRecord, InteractionError>

Marks a card Failed after the command it authorized did not commit.

§Errors

See Self::settle.

Source

pub async fn restore( &self, account: &AccountId, id: &InteractionId, ) -> Result<InteractionRecord, InteractionError>

Puts a card back to Active so the user may answer again.

§Errors

See Self::settle.

Source

pub async fn open_for_conversation( &self, account: &AccountId, conversation: &ConversationId, ) -> Result<Vec<Interaction>, InteractionError>

The open cards of a conversation, oldest first.

§Errors

InteractionError::NotPersisted when the store could not answer; silently pretending there are none would let a blocking card be bypassed (I19).

Source

pub async fn open_for_case( &self, account: &AccountId, case_key: &CaseKey, ) -> Result<Vec<Interaction>, InteractionError>

The open cards of one case, oldest first.

§Errors

See Self::open_for_conversation.

Source

pub async fn blocking_answered_at( &self, account: &AccountId, case_key: &CaseKey, revision: CaseRevision, ) -> Result<bool, InteractionError>

Whether the user has already answered a blocking card of this case at this revision.

What stops a declined card going straight back up. See InteractionReader::blocking_answered_at.

§Errors

See Self::open_for_conversation.

Source

pub async fn get( &self, account: &AccountId, id: &InteractionId, ) -> Result<InteractionRecord, InteractionError>

One stored card, whatever its status.

§Errors

See Self::open_for_conversation; an identifier of another tenant is InteractionRejection::NotFound.

Trait Implementations§

Source§

impl Clone for InteractionEngine

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 InteractionEngine

Source§

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

Formats the value using the given formatter. Read more

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> DynClone for T
where T: Clone,

Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more