Struct Reference

pub struct Reference { /* private fields */ }

Describes where and how a Symbol is used in the AST.

References indicate how they are being used using ReferenceFlags. Refer to the documentation for ReferenceFlags for more information.

Resolution

References to symbols that could be resolved have their symbol_id field populated. None indicates that either a global variable or a non-existent symbol is being referenced.

The node identified by node_id will be an IdentifierReference. Note that declarations do not count as references, even if the declaration is being used in an expression.

const arr = [1, 2, 3].map(function mapper(x) { return x + 1; });
//      Not considered a reference ^^^^^^

Implementations

impl Reference

pub fn new(node_id: NodeId, flags: ReferenceFlags) -> Reference

Create a new unresolved reference.

pub fn new_with_symbol_id( node_id: NodeId, symbol_id: SymbolId, flags: ReferenceFlags, ) -> Reference

Create a new resolved reference on a symbol.

pub fn node_id(&self) -> NodeId

Get the id of the node that is referencing the symbol.

pub fn symbol_id(&self) -> Option<SymbolId>

Get the id of the symbol being referenced.

Will return None if the symbol could not be resolved.

pub fn set_symbol_id(&mut self, symbol_id: SymbolId)

pub fn flags(&self) -> ReferenceFlags

pub fn flags_mut(&mut self) -> &mut ReferenceFlags

pub fn is_read(&self) -> bool

Returns true if the identifier value was read.

This is not mutually exclusive with Reference::is_write.

pub fn is_write(&self) -> bool

Returns true if the identifier was written to.

This is not mutually exclusive with Reference::is_read.

pub fn is_value(&self) -> bool

Returns true if this reference is used in a value context.

pub fn is_type(&self) -> bool

Returns true if this reference is used in a type context.

Trait Implementations

impl Clone for Reference

fn clone(&self) -> Reference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reference

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

Formats the value using the given formatter.

impl Serialize for Reference

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.