Enum inkling::error::InternalError

pub enum InternalError {
    BadKnotStack(StackError),
    CouldNotProcess(ProcessError),
    IncorrectChoiceIndex {
        selection: usize,
        available_choices: Vec<ChoiceInfo>,
        stack_index: usize,
        stack: Vec<usize>,
    },
    IncorrectNodeStack(IncorrectNodeStackError),
    UseOfVariableAsLocation {
        name: String,
    },
    UseOfUnvalidatedAddress {
        address: Address,
    },
}

Internal errors from inkling.

These are errors which arise when the library produces objects, trees, text or internal stacks that are inconsistent with each other or themselves.

If the library is well written these should not possibly occur; at least until this point every part of the internals are fully deterministic. That obviously goes for a lot of buggy code that has been written since forever, so nothing unique there.

Either way, all those sorts of errors are encapsulated here. They should never be caused by invalid user input or Ink files, those errors should be captured by either the parent InklingError or parsing ReadError error structures.

Variants

BadKnotStack(StackError)

The internal stack of knots is inconsistent or has not been set properly.

CouldNotProcess(ProcessError)

Could not Process a line of text into its final form.

IncorrectChoiceIndex

Selected branch index does not exist.

Fields of IncorrectChoiceIndex

selection: usize

Selection index.

available_choices: Vec<ChoiceInfo>

Available choices at the branching point.

stack_index: usize

Index in stack where the error occurred.

stack: Vec<usize>

Stack of choices from the root node to the branching point.

IncorrectNodeStack(IncorrectNodeStackError)

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

UseOfVariableAsLocation

Tried to use a variable address as a location.

Fields of UseOfVariableAsLocation

name: String

UseOfUnvalidatedAddress

Tried to use an unvalidated address after the story was parsed.

Fields of UseOfUnvalidatedAddress

address: Address

Trait Implementations

impl Clone for InternalError

fn clone(&self) -> InternalError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<InternalError> for InklingError

fn from(err: InternalError) -> Self

Performs the conversion.

impl Display for InternalError

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

Formats the value using the given formatter.

impl Debug for InternalError

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

Formats the value using the given formatter.

impl Error for InternalError

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.