Struct SymbolRef 

pub struct SymbolRef {
    pub owner: ModuleIdx,
    pub symbol: SymbolId,
}

SymbolRef is used to represent a symbol in a module when there are multiple modules.

Fields

owner: ModuleIdx

symbol: SymbolId

Implementations

impl SymbolRef

pub fn name<'db>(&self, db: &'db SymbolRefDb) -> &'db str

pub fn set_name(&self, db: &mut SymbolRefDb, name: &str)

pub fn flags<'db, T: GetLocalDb>( &self, db: &'db T, ) -> Option<&'db SymbolRefFlags>

Not all symbols have flags info, we only care about part of them. If you want to ensure the flags info exists, use flags_mut instead.

pub fn flags_mut<'db, T: GetLocalDbMut>( &self, db: &'db mut T, ) -> &'db mut SymbolRefFlags

pub fn is_declared_by_const(&self, db: &SymbolRefDb) -> Option<bool>

pub fn is_not_reassigned(&self, db: &SymbolRefDb) -> Option<bool>

None means we don’t know if it gets reassigned.

pub fn is_declared_in_root_scope(&self, db: &SymbolRefDb) -> bool

pub fn canonical_ref(&self, db: &SymbolRefDb) -> SymbolRef

pub fn set_canonical_ref(&self, db: &mut SymbolRefDb, canonical_ref: SymbolRef)

pub fn is_created_by_import_stmt_that_target_external( &self, db: &SymbolRefDb, modules: &IndexModules, ) -> bool

Trait Implementations

impl Clone for SymbolRef

fn clone(&self) -> SymbolRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolRef

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

Formats the value using the given formatter.

impl From<(ModuleIdx, SymbolId)> for SymbolRef

fn from(value: (ModuleIdx, SymbolId)) -> Self

Converts to this type from the input type.

impl From<SymbolRef> for SymbolOrMemberExprRef

fn from(value: SymbolRef) -> Self

Converts to this type from the input type.

impl Hash for SymbolRef

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 Ord for SymbolRef

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

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

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

impl Eq for SymbolRef

impl StructuralPartialEq for SymbolRef