Enum inkling::InklingError

pub enum InklingError {
    BadGraph(BadGraphKind),
    IncorrectStack {
        kind: IncorrectStackKind,
        stack: Vec<usize>,
    },
    InvalidChoice {
        index: usize,
        choice: Option<Choice>,
        presented_choices: Vec<(bool, Choice)>,
        internal_choices: Vec<ChoiceData>,
    },
    NoKnotStack,
    ResumeBeforeStart,
    StartOnStoryInProgress,
    UnknownKnot {
        knot_name: String,
    },
}

Internal error from walking through a story.

Most likely due to the DialogueNode tree of a story being constructed incorrectly, which will be due to a logical error in the set-up code since the user has no control over it.

Variants

BadGraph(BadGraphKind)

The graph of DialogueNodes has an incorrect structure. This can be that Choices are not properly nested under ChoiceSet nodes.

IncorrectStack

The current stack is not properly representing the graph or has some indexing problems.

Fields of IncorrectStack

kind: IncorrectStackKindstack: Vec<usize>

InvalidChoice

A choice was made with an internal index that does not match one existing in the set. Means that the choice set presented to the user was not created to represent the set of encountered choices, or that somehow a faulty choice was returned to continue the story with.

Fields of InvalidChoice

index: usize

Index of choice that was used internally when the choice was not found.

choice: Option<Choice>

Choice input by the user to resume the story with.

presented_choices: Vec<(bool, Choice)>

List of choices that were available for the selection and if they were given to the user in the Prompt::Choice set.

internal_choices: Vec<ChoiceData>

List of all choices that were available in their internal representation.

NoKnotStack

No root knot has been set to begin following the story from.

ResumeBeforeStart

Tried to resume a story that has not been started.

StartOnStoryInProgress

Tried to start a story that is already in progress.

UnknownKnot

The story tried to move to a knot that doesn't exist.

Fields of UnknownKnot

knot_name: String

Trait Implementations

impl Clone for InklingError

fn clone(&self) -> InklingError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for InklingError

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

Formats the value using the given formatter.

impl Debug for InklingError

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

Formats the value using the given formatter.

impl Error for InklingError

fn description(&self) -> &str

This method is soft-deprecated.

fn cause(&self) -> Option<&dyn Error>

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

The lower-level cause of this error, if any.

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.