Struct LocalVariable

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

A local variable.

Implementations

impl<'input> LocalVariable<'input>

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

The name of the variable.

pub fn type_offset(&self) -> TypeOffset

The type offset of the variable.

A type offset is unique for all types in a file.

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.

This will only be known for static variables.

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

The size in bytes of the variable.

pub fn registers(&self) -> impl Iterator<Item = (Range, Register)> + '_

The registers in which this variable is stored.

pub fn register_offsets( &self, ) -> impl Iterator<Item = (Range, Register, i64)> + '_

The registers pointing to where this variable is stored.

pub fn frame_locations(&self) -> impl Iterator<Item = FrameLocation> + '_

The stack frame locations at which this variable is stored.

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

Compare the identifying information of two variables.

Variables are considered equal if their names are equal.

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> Clone for LocalVariable<'input>

fn clone(&self) -> LocalVariable<'input>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'input> Debug for LocalVariable<'input>

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

Formats the value using the given formatter.

impl<'input> Default for LocalVariable<'input>

fn default() -> LocalVariable<'input>

Returns the “default value” for a type.