Struct foundry_compilers::artifacts::ast::VariableDeclaration

pub struct VariableDeclaration {

    pub id: usize,
    pub src: SourceLocation,
    pub name: String,
    pub name_location: Option<SourceLocation>,
    pub base_functions: Vec<usize>,
    pub constant: bool,
    pub state_variable: bool,
    pub documentation: Option<StructuredDocumentation>,
    pub function_selector: Option<String>,
    pub indexed: bool,
    pub mutability: Option<Mutability>,
    pub overrides: Option<OverrideSpecifier>,
    pub scope: usize,
    pub storage_location: StorageLocation,
    pub type_descriptions: TypeDescriptions,
    pub type_name: Option<TypeName>,
    pub value: Option<Expression>,
    pub visibility: Visibility,
}

A variable declaration.

Fields

id: usize

src: SourceLocation

name: String

name_location: Option<SourceLocation>

base_functions: Vec<usize>

constant: bool

Marks whether or not the variable is a constant before Solidity 0.7.x.

After 0.7.x you must use mutability. For cross-version compatibility use VariableDeclaration::mutability().

state_variable: bool

Marks whether or not the variable is a state variable before Solidity 0.7.x.

After 0.7.x you must use mutability. For cross-version compatibility use VariableDeclaration::mutability().

documentation: Option<StructuredDocumentation>

function_selector: Option<String>

indexed: bool

mutability: Option<Mutability>

Marks the variable’s mutability from Solidity 0.7.x onwards. For cross-version compatibility use VariableDeclaration::mutability().

overrides: Option<OverrideSpecifier>

scope: usize

storage_location: StorageLocation

type_descriptions: TypeDescriptions

type_name: Option<TypeName>

value: Option<Expression>

visibility: Visibility

Implementations

impl VariableDeclaration

pub fn mutability(&self) -> &Mutability

Returns the mutability of the variable that was declared.

This is a helper to check variable mutability across Solidity versions.

Trait Implementations

impl Clone for VariableDeclaration

fn clone(&self) -> VariableDeclaration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VariableDeclaration

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VariableDeclaration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VariableDeclaration

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for VariableDeclaration

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Walk for VariableDeclaration

fn walk(&self, visitor: &mut dyn Visitor)

impl Eq for VariableDeclaration

impl StructuralPartialEq for VariableDeclaration