Enum State

pub enum State {
    ParseError,
    CodeTooLong,
    UnexpectedEnd,
    UnexpectedProgramEnd,
    UnexpectedRegexpBegin,
    UnterminatedBlock,
    UnterminatedHeredoc,
    UnterminatedString,
    Valid,
}

State shows whether artichoke can parse some code or why it cannot.

This enum only encapsulates whether artichoke can parse the code. It may still have syntactic or semantic errors.

Variants

ParseError

Internal parser error. This is a fatal error.

CodeTooLong

Code must be fewer than isize::MAX bytes.

UnexpectedEnd

The code has too many end statements.

UnexpectedProgramEnd

The code has unclosed blocks.

UnexpectedRegexpBegin

The current expression is an unterminated Regexp.

UnterminatedBlock

The current expression is an unterminated block.

UnterminatedHeredoc

The current expression is an unterminated heredoc.

UnterminatedString

The current expression is an unterminated String.

Valid

Code is valid and fit to eval.

Implementations

impl State

pub const fn new() -> Self

Construct a new, default State.

pub fn is_code_block_open(self) -> bool

Whether this variant indicates a code block is open.

This method can be used by a REPL to check whether to buffer code or begin a multi-line editing session before attempting to eval the code on an interpreter.

pub fn is_recoverable_error(self) -> bool

Whether this variant is a recoverable error.

Recoverable errors should be handled by resetting the parser and input buffer.

pub fn is_fatal(self) -> bool

Whether this variant is a fatal parse error.

Fatal parser states indicate the parser is corrupted and cannot be used again.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> Self

Returns the “default value” for a type.

impl Hash for State

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for State

fn cmp(&self, other: &State) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for State

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for State

fn partial_cmp(&self, other: &State) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for State

impl Eq for State

impl StructuralPartialEq for State