Struct Variable

pub struct Variable<'input> { /* private fields */ }

A global variable.

Implementations

impl<'input> Variable<'input>

pub fn id(&self) -> usize

The user defined id for this variable.

pub fn set_id(&self, id: usize)

Set a user defined id for this variable.

pub fn namespace(&self) -> Option<&Namespace<'_>>

The namespace of the variable.

pub fn name(&self) -> Option<&str>

The name of the variable.

pub fn linkage_name(&self) -> Option<&str>

The linkage name of the variable.

pub fn symbol_name(&self) -> Option<&str>

The symbol name of the variable.

This is determined from a symbol table entry with a matching address.

pub fn ty<'a>( &self, hash: &'a FileHash<'input>, ) -> Option<Cow<'a, Type<'input>>>

The type of the variable.

Returns None if the type is invalid.

pub fn source(&self) -> &Source<'input>

The source information for the variable.

pub fn address(&self) -> Option<u64>

The address of the variable.

pub fn byte_size(&self, hash: &FileHash<'_>) -> Option<u64>

The size in bytes of the variable.

pub fn range(&self, hash: &FileHash<'_>) -> Option<Range>

The address range of the variable.

pub fn is_declaration(&self) -> bool

Return true if this is a declaration.

pub fn cmp_id( _hash_a: &FileHash<'_>, a: &Variable<'_>, _hash_b: &FileHash<'_>, b: &Variable<'_>, ) -> Ordering

Compare the identifying information of two variables.

Variables are equal if they have the same namespace and name.

This can be used to sort, and to determine if two variables refer to the same definition (even if there are differences in the definitions).

Trait Implementations

impl<'input> Debug for Variable<'input>

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

Formats the value using the given formatter.

impl<'input> Default for Variable<'input>

fn default() -> Variable<'input>

Returns the “default value” for a type.