Struct ErrorRef 

pub struct ErrorRef {
    pub id: Id,
    pub entry: Entry,
}

A globally unique reference of the syntax error in the syntax tree.

Each syntax tree’s syntax error could be uniquely addressed within a pair of the Id and Entry, where the identifier uniquely addresses a specific compilation unit instance (syntax tree), and the entry part addresses a syntax error within this tree.

Essentially, ErrorRef is a composite index.

Both components of this index form a unique pair (within the current process), because each compilation unit has a unique identifier, and the syntax errors within the syntax tree always receive unique Entry indices within the syntax tree.

If the syntax error instance has been removed from the syntax tree over time, new syntax error within this syntax tree will never occupy the same ErrorRef object, but the ErrorRef referred to the removed SyntaxError would become invalid.

The nil ErrorRefs are special references that are considered to be always invalid (they intentionally don’t refer to any syntax error within any syntax tree).

Two distinct instances of the nil ErrorRef are always equal.

Fields

id: Id

An identifier of the syntax tree.

entry: Entry

A versioned index of the syntax error instance within the syntax tree.

Implementations

impl ErrorRef

pub const fn nil() -> Self

Returns an ErrorRef that intentionally does not refer to any syntax error within any syntax tree.

If you need just a static reference to the nil ErrorRef, use the predefined NIL_ERROR_REF static.

pub const fn is_nil(&self) -> bool

Returns true, if the underlying reference intentionally does not refer to any syntax error within any syntax tree.

pub fn deref<'tree, N: Node>( &self, tree: &'tree impl SyntaxTree<Node = N>, ) -> Option<&'tree SyntaxError>

Immutably borrows a syntax tree’s syntax error referred to by this ErrorRef.

Returns None if this ErrorRef is not valid for specified tree.

pub fn is_valid_ref(&self, tree: &impl SyntaxTree) -> bool

Returns true if the syntax error referred to by this ErrorRef exists in the specified tree.

Trait Implementations

impl Clone for ErrorRef

fn clone(&self) -> ErrorRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorRef

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

Formats the value using the given formatter.

impl Hash for ErrorRef

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 Identifiable for ErrorRef

fn id(&self) -> Id

Returns the globally unique identifier of the compilation unit to which this object belongs.

impl Ord for ErrorRef

fn cmp(&self, other: &ErrorRef) -> 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 ErrorRef

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

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

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 ErrorRef

fn partial_cmp(&self, other: &ErrorRef) -> 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 ErrorRef

impl Eq for ErrorRef

impl StructuralPartialEq for ErrorRef