Enum ArithError 

#[non_exhaustive]
pub enum ArithError {
    InvalidNumericConstant,
    InvalidCharacter,
    IncompleteExpression,
    MissingOperator,
    UnclosedParenthesis {
        opening_location: Location,
    },
    QuestionWithoutColon {
        question_location: Location,
    },
    ColonWithoutQuestion,
    InvalidOperator,
    NonPortableIncrementDecrement,
    InvalidVariableValue(String),
    Overflow,
    DivisionByZero,
    LeftShiftingNegative,
    ReverseShifting,
    AssignmentToValue,
    Unrecognized(String),
}

Types of errors that may occur in arithmetic expansion

This enum is essentially equivalent to yash_arith::ErrorCause. The differences between the two are:

• ArithError defines all error variants flatly while ErrorCause has nested variants.
• ArithError may contain informative Location that can be used to produce an error message with annotated code while ErrorCause may just specify a location as an index range.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidNumericConstant

A value token contains an invalid character.

InvalidCharacter

An expression contains a character that is not a whitespace, number, or number.

IncompleteExpression

Expression with a missing value

MissingOperator

Operator missing

UnclosedParenthesis

( without )

Fields

opening_location: Location

QuestionWithoutColon

? without :

Fields

question_location: Location

ColonWithoutQuestion

: without ?

InvalidOperator

Other error in operator usage

NonPortableIncrementDecrement

An increment or decrement operator is used while the portable option is on.

InvalidVariableValue(String)

A variable value that is not a valid number

Overflow

Result out of bounds

DivisionByZero

Division by zero

LeftShiftingNegative

Left bit-shifting of a negative value

ReverseShifting

Bit-shifting with a negative right-hand-side operand

AssignmentToValue

Assignment with a left-hand-side operand not being a variable

Unrecognized(String)

An arithmetic error not recognized by this crate

This variant is used to wrap an error cause that is returned by future versions of yash_arith but not yet recognized by this crate. The associated string is the Display representation of the error cause.

Implementations

impl ArithError

pub fn related_location(&self) -> Option<(&Location, &'static str)>

Returns a location related with this error and a message describing the location.

Trait Implementations

impl Clone for ArithError

fn clone(&self) -> ArithError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArithError

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

Formats the value using the given formatter.

impl Display for ArithError

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

Formats the value using the given formatter.

impl Eq for ArithError

impl Error for ArithError

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<ArithError> for ErrorCause

fn from(source: ArithError) -> Self

Converts to this type from the input type.

impl PartialEq for ArithError

fn eq(&self, other: &ArithError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ArithError