Struct Symbol 

pub struct Symbol {
    pub package_qualifier: Option<Span>,
    pub index_qualifier: Option<Span>,
    /* private fields */
}

A typed Macaulay2 symbol syntax leaf.

Fields

package_qualifier: Option<Span>

The package-name portion before the first $, when this is a package-qualified symbol.

index_qualifier: Option<Span>

The decimal index after the final $, when this is an indexed symbol.

Implementations

impl Symbol

pub fn new(text: impl AsRef<str>, span: Span) -> Self

Creates a leaf from its text and source span.

pub fn text(&self) -> &str

Returns the leaf spelling.

Examples found in repository

examples/hierarchy_visit_emit.rs (line 12)

    fn visit_symbol(&mut self, symbol: &'ast Symbol) {
        self.symbols.push(symbol.text().to_owned());
    }

examples/type_inference.rs (line 253)

    fn symbol(&self, symbol: &Symbol) -> DemoFact {
        self.symbols
            .get(symbol.text())
            .cloned()
            .unwrap_or_else(|| Self::deferred(format!("symbol `{}`", symbol.text())))
    }

pub fn set_text(&mut self, text: impl AsRef<str>)

Replaces the spelling with a new immutable source snapshot.

Trait Implementations

impl Debug for Symbol

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

Formats the value using the given formatter.

impl From<Symbol> for AssignmentPackComponent

fn from(value: Symbol) -> Self

Converts to this type from the input type.

impl From<Symbol> for Component

fn from(value: Symbol) -> Self

Converts to this type from the input type.

impl From<Symbol> for Expr

fn from(value: Symbol) -> Self

Converts to this type from the input type.

impl Lex for Symbol

fn to_tokens(&self, output: &mut TokenStream)

Appends this value’s token trees to output.

fn to_token_stream(&self) -> TokenStream

Emits this value into a fresh token stream.

fn to_m2(&self) -> String

Renders this value as normalized Macaulay2 source.

impl<N> Migrate<N> for Symbol

where N: ExternalCstNode,

fn matches(node: &N) -> bool

Reports whether node can migrate this typed value.

fn migrate(node: N) -> Result<Self, MigrateError>

Converts a matching external node into typed syntax.

impl PrettyTree for Symbol

fn pretty_tree(&self) -> PrettyNode

Builds the presentation node for this syntax value.

impl Spanned for Symbol

fn try_span(&self) -> Option<Span>

Returns the smallest span covering this value, when its constituents share one source snapshot.

fn span(&self) -> Span

Returns the smallest span covering this value.

fn expect_span(&self) -> Span

Returns this value’s span when one source snapshot covers it.

impl Terminal for Symbol

fn leading_trivia(&self) -> &LeadingTrivia

Borrows the comments preceding this terminal.

fn leading_trivia_mut(&mut self) -> &mut LeadingTrivia

Mutably borrows the comments preceding this terminal.

fn trailing_trivia(&self) -> &TrailingTrivia

Borrows the comments following this terminal.

fn trailing_trivia_mut(&mut self) -> &mut TrailingTrivia

Mutably borrows the comments following this terminal.

fn set_leading_trivia(&mut self, trivia: impl IntoIterator<Item = Trivia>)

where Self: Sized,

Replaces the comments preceding this terminal.

fn set_trailing_trivia(&mut self, trivia: impl IntoIterator<Item = Trivia>)

where Self: Sized,

Replaces the comments and layout characters following this terminal.