Enum LookupOutcome 

pub enum LookupOutcome {
    NotLookup,
    Off {
        id: String,
    },
    Miss {
        id: String,
    },
    Answer(LookupAnswer),
    Context(LookupAnswer),
}

What a routed request does once its target is known.

Variants

NotLookup

The target is the backbone or an ordinary skill: run its lane.

Off

The target is a lookup record but the mode is off: the backbone runs the plain message.

Fields

id: String

Miss

A lookup record, no key in the message: the backbone runs the plain message — unchanged, bit-identical to F0.

Fields

id: String

Answer(LookupAnswer)

answer mode: the table’s text IS the answer; nothing runs.

Context(LookupAnswer)

context mode: the backbone runs context_prompt(card, message).

Implementations

impl LookupOutcome

pub fn hit(&self) -> Option<&LookupAnswer>

The table’s answer when a key was found (either mode).

pub fn is_hit(&self) -> bool

pub fn generation_text(&self, user_text: &str) -> String

The text the backbone generates from (context mode prepends the card; everything else keeps user_text).

pub fn describe(&self) -> Option<String>

One human line for a lookup target (None for Self::NotLookup).

pub fn lookup_id(&self) -> Option<&str>

The lookup record the router decided on (Off, Miss and the hits), None for any other target.

pub fn decided_by(&self) -> Option<DecidedBy>

Who sent the request to the lookup record (None for Self::NotLookup): a hit says, Off / Miss come only from the decision the lookup step was handed (the key_first policy takes a request only when the table answers it).

pub fn annotate(&self, summary: &mut Value, mode: LookupMode)

Adds the lookup fields to a route summary (RouteDecision::summary_json): lookup_hit; whenever the target was a lookup record lookup_mode, decided_target (the record the decision chose — target is the lane that ran, the backbone after a miss) and decided_by (router | key_first); on a hit lookup_key, lookup_entry, lookup_lang, field, lookup_match (exact | stem), lookup_turn (how many user turns back the key was found; 0 = the message routed on), lookup_key_words.

Trait Implementations

impl Clone for LookupOutcome

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 LookupOutcome

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

Formats the value using the given formatter.

impl Eq for LookupOutcome

impl PartialEq for LookupOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LookupOutcome