Struct Variable

pub struct Variable { /* private fields */ }

Implementations

impl Variable

pub fn new(scope: usize, index: usize) -> Self

Create a variable, where we already know the scope and index it will be bound to

pub fn new_dynamic(name: &str) -> Self

Create a dynamic variable, which will be bound to the first scope that uses it

Warning: this is not stable or tested yet. This implementation is still incomplete.

pub fn try_scope(&self) -> GritResult<u16>

Try to get the scope of the variable, if it has been bound to a scope. If the variable has not been bound to a scope, return an error. When possible, prefer to use get_scope() instead, which will initialize the variable’s scope if it is not already bound.

pub fn try_index(&self) -> GritResult<u16>

Try to get the index of the variable, if it has been bound to an index. If the variable has not been bound to an index, return an error. When possible, prefer to use get_index() instead, which will initialize the variable’s index if it is not already bound.

pub fn get_scope<Q: QueryContext>( &self, state: &mut State<'_, Q>, ) -> GritResult<u16>

Get the scope of the variable, initializing it if it is not already bound.

pub fn get_index<Q: QueryContext>( &self, state: &mut State<'_, Q>, ) -> GritResult<u16>

Get the index of the variable, initializing it if it is not already bound.

pub fn get_pattern_or_resolved<'a, 'b, Q: QueryContext>( &self, state: &'b State<'a, Q>, ) -> GritResult<Option<PatternOrResolved<'a, 'b, Q>>>

pub fn get_pattern_or_resolved_mut<'a, 'b, Q: QueryContext>( &self, state: &'b mut State<'a, Q>, ) -> GritResult<Option<PatternOrResolvedMut<'a, 'b, Q>>>

pub fn file_name() -> Self

pub fn is_file_name(&self) -> bool

pub fn is_program(&self) -> bool

pub fn is_probably_match(&self) -> bool

We auto-insert a $match variable during auto-wrap, which we can usually treat as being usable in the program body

pub fn text<'a, Q: QueryContext>( &self, state: &State<'a, Q>, lang: &Q::Language<'a>, ) -> GritResult<Cow<'a, str>>

Trait Implementations

impl Clone for Variable

fn clone(&self) -> Variable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Variable

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

Formats the value using the given formatter.

impl<Q: QueryContext> Matcher<Q> for Variable

fn execute<'a>( &'a self, resolved_pattern: &Q::ResolvedPattern<'a>, state: &mut State<'a, Q>, context: &'a Q::ExecContext<'a>, logs: &mut AnalysisLogs, ) -> GritResult<bool>

impl PatternName for Variable

fn name(&self) -> &'static str