Enum inkling::InklingError

pub enum InklingError {
    Internal(InternalError),
    InvalidAddress(InvalidAddressError),
    InvalidChoice {
        selection: usize,
        presented_choices: Vec<Choice>,
    },
    OutOfChoices {
        address: Address,
    },
    OutOfContent,
    ResumeBeforeStart,
    StartOnStoryInProgress,
    ProcessError,
}

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

Internal(InternalError)

Internal errors caused by inkling.

InvalidAddress(InvalidAddressError)

An invalid address was encountered when following the story.

InvalidChoice

A choice was made with an internal index that does not match one existing in the set. This 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

selection: usize

Choice input by the user to resume the story with.

presented_choices: Vec<Choice>

List of choices that were available for the selection

OutOfChoices

No choices or fallback choices were available in a story branch at the given address.

Fields of OutOfChoices

address: Address

OutOfContent

No content was available for the story to continue from.

ResumeBeforeStart

Tried to resume a story that has not been started.

StartOnStoryInProgress

Tried to start a story that is already in progress.

ProcessError

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 From<InvalidAddressError> for InklingError

fn from(err: InvalidAddressError) -> Self

Performs the conversion.

impl From<String> for InklingError

fn from(_: String) -> Self

Performs the conversion.

impl Debug for InklingError

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

Formats the value using the given formatter.

impl Display 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.