Struct UnderstandingBuilder 

pub struct UnderstandingBuilder { /* private fields */ }

Builds an Understanding of one message from quotes of it.

use turnframe_test::providers::UnderstandingBuilder;

let understanding = UnderstandingBuilder::of("set the name to Lisbon")
    .apply("trip.set_name", "tok_1", serde_json::json!({"value": "Lisbon"}), "set the name to Lisbon")
    .build()
    .unwrap();
assert_eq!(understanding.acts[0].arguments["value"].excerpt.unwrap().words.first, 4);

Implementations

impl UnderstandingBuilder

pub fn of(text: impl AsRef<str>) -> Self

Starts an understanding of text.

pub fn text(&self) -> &str

The message, as given.

pub fn apply( self, operation: impl Into<OperationKey>, target: impl Into<TargetToken>, arguments: Value, quote: &str, ) -> Self

An act applying operation to the record target names, asked for in quote.

pub fn apply_to( self, operation: impl Into<OperationKey>, target: ActTarget, arguments: Value, quote: &str, ) -> Self

An act applying operation to any target.

pub fn apply_to_unlisted( self, operation: impl Into<OperationKey>, workflow: impl Into<WorkflowKey>, named: &str, arguments: Value, quote: &str, ) -> Self

An act applying operation to a record of workflow the user named in named that is not in view, for the directory to look up.

pub fn open( self, operation: impl Into<OperationKey>, workflow: impl Into<WorkflowKey>, arguments: Value, quote: &str, ) -> Self

An act applying operation to a record of workflow it creates.

pub fn start(self, workflow: impl Into<WorkflowKey>, quote: &str) -> Self

An act starting a new case of workflow.

pub fn with_record(self, name: &str, record: RecordValue) -> Self

Gives the last act an argument naming a record. A record an earlier act of the turn creates makes that act a prerequisite.

pub fn last_act(&self) -> Option<ActId>

The id of the act added last.

pub fn with_status(self, status: ActStatus) -> Self

Replaces the last act’s status.

pub fn needing(self, arguments: &[&str]) -> Self

Marks the last act as asking for arguments.

pub fn superseded_by_next(self) -> Self

Marks the last act as superseded by a later unit, removing it from the acts.

pub fn ask(self, quote: &str) -> Self

A question answered against the current committed state.

pub fn ask_about( self, basis: AnswerBasis, record: Option<TargetToken>, subjects: &[&str], quote: &str, ) -> Self

A question with its basis, record and subjects; one on general domain knowledge is about the domain, the rest about a record, until Self::about says otherwise.

pub fn following_up(self) -> Self

Marks the last question as following up the assistant’s last message.

pub fn about(self, topic: QuestionTopic) -> Self

Sets what kind of thing the last question asks.

pub fn constrain(self, kind: ConstraintKind, quote: &str) -> Self

A turn-wide constraint stated in quote.

pub fn answer_card(self, option: impl Into<OptionId>, quote: &str) -> Self

A typed answer to the card on screen.

pub fn dispute(self, receipt: Option<&str>, quote: &str) -> Self

A dispute of the receipt shown under receipt, when it names one.

pub fn not_understood(self, reason: NotUnderstoodReason, quote: &str) -> Self

Words that produced nothing to act on.

pub fn chitchat(self, quote: &str) -> Self

Greetings, thanks, words that ask for nothing.

pub fn build(self) -> Result<Understanding, QuoteNotFound>

Finishes the understanding.

Errors

QuoteNotFound for the first quote that is not in the text.

Trait Implementations

impl Clone for UnderstandingBuilder

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 UnderstandingBuilder

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

Formats the value using the given formatter.