Enum RuntimeError 

pub enum RuntimeError {
    Decode(DecodeError),
    UnresolvedDefinition(DefinitionId),
    NoRootContainer,
    StackUnderflow,
    CallStackUnderflow,
    ContainerStackUnderflow,
    InvalidChoiceIndex {
        index: usize,
        available: usize,
    },
    NotWaitingForChoice,
    StoryEnded,
    UnresolvedGlobal(DefinitionId),
    TypeError(String),
    DivisionByZero,
    Unimplemented(String),
    UnresolvedExternalCall(DefinitionId),
    CaptureUnderflow,
    UnknownFlow(String),
    FlowAlreadyExists(String),
    RanOutOfContent,
    StepLimitExceeded(u64),
    LineLimitExceeded(usize),
    LocaleChecksumMismatch {
        expected: u32,
        actual: u32,
    },
    LocaleScopeNotInBase(DefinitionId),
    LocaleScopeMissing(DefinitionId),
    FunctionYielded,
    NotEvaluatingFunction,
    AlreadyEvaluatingFunction,
    FunctionNotFound(String),
    AsyncExternalInCall(String),
    UnknownPath(String),
    JumpWhileAwaitingExternal {
        path: String,
        external: String,
    },
    ArgCountMismatch {
        target: String,
        expected: u8,
        got: usize,
    },
}

Errors that can occur during story linking or execution.

Variants

Decode(DecodeError)

UnresolvedDefinition(DefinitionId)

NoRootContainer

StackUnderflow

CallStackUnderflow

ContainerStackUnderflow

InvalidChoiceIndex

Fields

index: usize

available: usize

NotWaitingForChoice

StoryEnded

UnresolvedGlobal(DefinitionId)

TypeError(String)

DivisionByZero

Unimplemented(String)

UnresolvedExternalCall(DefinitionId)

CaptureUnderflow

UnknownFlow(String)

FlowAlreadyExists(String)

RanOutOfContent

StepLimitExceeded(u64)

LineLimitExceeded(usize)

LocaleChecksumMismatch

Fields

expected: u32

actual: u32

LocaleScopeNotInBase(DefinitionId)

LocaleScopeMissing(DefinitionId)

FunctionYielded

NotEvaluatingFunction

AlreadyEvaluatingFunction

FunctionNotFound(String)

call_function was given a name that resolves to no function/knot.

AsyncExternalInCall(String)

A function evaluated via the synchronous call_function path called an external whose handler deferred (Pending) — it can’t be resolved in a one-shot synchronous call.

UnknownPath(String)

choose_path_string was given a path that resolves to no knot, stitch, or label.

JumpWhileAwaitingExternal

choose_path_string was called while the flow is parked on an unresolved external call. A pending host call cannot be silently abandoned — resolve it (or reset the story) before jumping.

Fields

path: String

external: String

ArgCountMismatch

A host-directed entry (choose_path_string_with_args) — or a call_function — was given the wrong number of arguments for the target’s declared parameters.

Fields

target: String

The knot/stitch/function path or name.

expected: u8

Declared parameter count.

got: usize

Arguments the host supplied.

Trait Implementations

impl Debug for RuntimeError

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

Formats the value using the given formatter.

impl Display for RuntimeError

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

Formats the value using the given formatter.

impl Error for RuntimeError

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<DecodeError> for RuntimeError

fn from(source: DecodeError) -> Self

Converts to this type from the input type.