Struct Symbol 

pub struct Symbol {
    pub name: String,
    pub exported: Option<String>,
    pub module: Option<String>,
}

Where a name came from.

Fields

name: String

The name as it appears at the use site the oracle read, not at the declaration.

For a renamed import — import { Decimal as Money } — this is the local alias Money. It stays the use-site spelling because it is what a message should quote: the reader has Money in front of them, and a violation naming Decimal would send them looking for text that is not in their file. Symbol::exported is the field to compare against an expected export name.

exported: Option<String>

The name the module exports this under, when it was imported.

Binding	exported
import { a } from 'm', import { a as b } from 'm', m’s declaration file unreadable	Some("a")
import { a } from 'm', import { a as b } from 'm', m’s declaration file readable	the name that file declares
import d from 'm', m’s declaration file unreadable	Some("default")
import d from 'm', m’s declaration file readable	the name that file declares
import * as ns from 'm'	None
a local declaration	None

Copied even when nothing was renamed, rather than None standing for “same as name”. The consumer is a comparison against a required export name, and under a None-when-unrenamed contract a caller who forgot the ?? name fallback would silently accept every plain import — the most ordinary spelling there is, and a failure that only ever removes reports, so nothing about the output would look wrong. A copy costs one String per symbol and cannot fail that way.

A namespace import binds the module object, which no single export names, so it is None rather than a "*" sentinel: a sentinel is a string a comparison can match, and there is nothing here for a name comparison to be right about.

Binding::is_import_of, the predicate behind ctx.resolvesToImport, does spell a namespace import "*", and the two do not conflict: there "*" is what a rule writes to ask for the namespace form, a query vocabulary; here the value is an answer a rule compares against, and an answer of "*" would satisfy any comparison that happened to write it.

module: Option<String>

The module it was imported from, when it was imported. None for a local declaration, which is what distinguishes an imported Decimal from a local class that happens to share the name.

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Eq for Symbol

impl Ord for Symbol

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Symbol

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Symbol

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