Struct inkling::error::parse::validate::ValidationError

pub struct ValidationError {
    pub invalid_address_errors: Vec<InvalidAddressError>,
    pub name_space_errors: Vec<NameSpaceCollision>,
    pub variable_errors: Vec<InvalidVariableExpression>,
}

Collection of errors encountered when validating a story.

Fields

invalid_address_errors: Vec<InvalidAddressError>

Errors from invalid addresses to knots, stitchs or variables.

name_space_errors: Vec<NameSpaceCollision>

Errors from name space collisions between knots, stitches and variables.

Stitches or global variables may not have the same name as any knot in the story. Nor may stitches have the same name as any global variable.

This is to ensure that addresses are well determined. Internal addresses to stitches within knots can exclude the knot name, meaning that if a stitch and knot share a name it will not be clear which of the two an address refers to. The same problem goes for global variables.

variable_errors: Vec<InvalidVariableExpression>

Errors from expressions and conditions containing invalid variables.

Expressions must evaluate to a valid variable. For example, mathematics can only include numerical variables and will produce a numerical variable. If an expression in the story tries to add a string to an integer an error will be yielded in this collection.

Conditions likewise cannot compare different types to each other. Such errors will also be collected in this set.

See Variable for more information about valid operations and comparisons between variables.

Trait Implementations

impl Debug for ValidationError

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

Formats the value using the given formatter.

impl Display for ValidationError

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

Formats the value using the given formatter.

impl Error for ValidationError

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

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

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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

impl From<ValidationError> for ReadError

fn from(err: ValidationError) -> Self

Performs the conversion.