Skip to main content

SignatureLocalVariables

Struct SignatureLocalVariables 

pub struct SignatureLocalVariables {
    pub locals: Vec<SignatureLocalVariable>,
}
Expand description

Local variable signature collection for method bodies.

Represents the complete local variable signature according to ECMA-335 Section II.23.2.6. This contains all local variables declared within a method body, including their types, modifiers, and special attributes like pinning and reference semantics.

§Local Variable Characteristics

§Scope and Lifetime

Local variables are scoped to the method in which they are declared:

  • Created when the method is entered
  • Destroyed when the method exits
  • Accessible only within the declaring method
  • Zero-initialized by default unless explicitly assigned

§Memory Management

Local variables use stack-based allocation by default:

  • Value types: Stored directly on the stack
  • Reference types: References stored on stack, objects on heap
  • Pinned variables: Prevent garbage collection movement
  • Large objects: May be allocated on the large object heap

§Binary Format (ECMA-335)

Local variable signatures are encoded as:

LocalVarSig ::= LOCAL_SIG Count (TYPEDBYREF | ([CustomMod]* [Constraint])* [BYREF] Type)*

§Examples

§Simple Local Variables

use dotscope::metadata::signatures::{SignatureLocalVariables, SignatureLocalVariable, TypeSignature};

let locals = SignatureLocalVariables {
    locals: vec![
        SignatureLocalVariable {
            modifiers: vec![],
            is_byref: false,
            is_pinned: false,
            base: TypeSignature::I4,           // int local
        },
        SignatureLocalVariable {
            modifiers: vec![],
            is_byref: false,
            is_pinned: false,
            base: TypeSignature::String,       // string local
        },
    ],
};

§Complex Local Variables

use dotscope::metadata::signatures::{SignatureLocalVariables, SignatureLocalVariable, TypeSignature};

let complex_locals = SignatureLocalVariables {
    locals: vec![
        SignatureLocalVariable {
            modifiers: vec![],
            is_byref: true,                    // ref variable
            is_pinned: false,
            base: TypeSignature::I4,
        },
        SignatureLocalVariable {
            modifiers: vec![],
            is_byref: false,
            is_pinned: true,                   // pinned variable
            base: TypeSignature::String,
        },
    ],
};

§Thread Safety

SignatureLocalVariables is immutable after construction and safe to share between threads. The actual local variable storage is thread-local per method execution.

§ECMA-335 Compliance

This structure implements ECMA-335 Partition II, Section 23.2.6 (LocalVarSig) and supports all standard local variable signature scenarios.

§See Also

Fields§

§locals: Vec<SignatureLocalVariable>

The collection of local variables declared in this method.

Each SignatureLocalVariable represents a single local variable with its type, modifiers, and special attributes. The order matches the declaration order in the method body.

§Variable Access

Local variables are accessed by index in IL instructions:

  • ldloc.0, ldloc.1, etc. for loading local variables
  • stloc.0, stloc.1, etc. for storing to local variables
  • Index corresponds to position in this vector

§Empty Collections

Methods without local variables have an empty vector. This is common for simple methods that only use parameters.

Trait Implementations§

§

impl Clone for SignatureLocalVariables

§

fn clone(&self) -> SignatureLocalVariables

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for SignatureLocalVariables

§

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

Formats the value using the given formatter. Read more
§

impl Default for SignatureLocalVariables

§

fn default() -> SignatureLocalVariables

Returns the “default value” for a type. Read more
§

impl PartialEq for SignatureLocalVariables

§

fn eq(&self, other: &SignatureLocalVariables) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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 StructuralPartialEq for SignatureLocalVariables

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, A> IntoAst<A> for T
where T: Into<A>, A: Ast,

Source§

fn into_ast(self, _a: &A) -> A

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.