Struct UnderstandingInput 

#[non_exhaustive]
pub struct UnderstandingInput {
    pub message: Words,
    pub locale: Locale,
    pub today: NaiveDate,
    pub transcript: Vec<TranscriptMessage>,
    pub workflows: Vec<WorkflowBrief>,
    pub card: Option<OpenCard>,
    pub expectation: Option<Expectation>,
    pub waiting: Vec<PendingAct>,
    pub done: Vec<PendingAct>,
    pub receipts: Vec<PreviousReceipt>,
    pub last_subjects: Vec<TargetToken>,
    pub settings: Option<Settings>,
}

The input of one turn’s understanding.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

message: Words

The user’s message.

locale: Locale

The turn’s language.

today: NaiveDate

Today, in the user’s time zone: what relative dates count from.

transcript: Vec<TranscriptMessage>

The most recent messages before this one, oldest first.

workflows: Vec<WorkflowBrief>

The workflows in view, in registration order.

card: Option<OpenCard>

The card waiting for an answer.

expectation: Option<Expectation>

What the assistant asked for last turn.

waiting: Vec<PendingAct>

Acts of earlier turns still waiting for a record the user named that did not exist.

done: Vec<PendingAct>

Acts the last turn did, with the values they were given: a correction changes what it says of one and keeps the rest.

receipts: Vec<PreviousReceipt>

What the assistant reported doing last turn, so a dispute can name it.

last_subjects: Vec<TargetToken>

The records the assistant’s last message was about.

settings: Option<Settings>

How this turn is run, over the understander’s own settings.

Implementations

impl UnderstandingInput

pub fn new(message: &str, locale: impl Into<Locale>, today: NaiveDate) -> Self

A turn saying message on today, with nothing else in view.

pub const fn with_settings(self, settings: Settings) -> Self

Runs this turn under settings instead of the understander’s.

pub fn with_workflow(self, workflow: WorkflowBrief) -> Self

Adds a workflow.

pub fn with_earlier(self, speaker: Speaker, text: &str) -> Self

Adds an earlier message.

pub fn with_card(self, card: OpenCard) -> Self

Sets the card on screen.

pub fn with_expectation(self, expectation: Expectation) -> Self

Sets what the assistant asked for.

pub fn with_waiting(self, act: PendingAct) -> Self

Adds an act of an earlier turn still waiting for a record the user named.

pub fn with_done(self, act: PendingAct) -> Self

Adds an act the last turn did.

pub fn with_receipt(self, receipt: PreviousReceipt) -> Self

Adds a receipt of the last turn.

pub fn with_last_subject(self, record: TargetToken) -> Self

Adds a record the assistant’s last message was about.

pub fn workflow(&self, key: &WorkflowKey) -> Option<&WorkflowBrief>

The workflow with this key.

pub fn operation( &self, key: &OperationKey, ) -> Option<(&WorkflowBrief, &OperationSpec)>

The operation with this key, and its workflow.

pub fn record( &self, token: &TargetToken, ) -> Option<(&WorkflowBrief, &RecordBrief)>

The record with this token, and its workflow.

Trait Implementations

impl Clone for UnderstandingInput

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnderstandingInput

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

Formats the value using the given formatter.