Struct Variable 

pub struct Variable<'hir> {

    pub source: SourceId,
    pub contract: Option<ContractId>,
    pub function: Option<FunctionId>,
    pub span: Span,
    pub kind: VarKind,
    pub ty: Type<'hir>,
    pub name: Option<Ident>,
    pub visibility: Option<Visibility>,
    pub mutability: Option<VarMut>,
    pub data_location: Option<DataLocation>,
    pub override_: bool,
    pub overrides: &'hir [ContractId],
    pub indexed: bool,
    pub initializer: Option<&'hir Expr<'hir>>,
    pub getter: Option<FunctionId>,
}

A constant or variable declaration.

Fields

source: SourceId

The source this variable is defined in.

contract: Option<ContractId>

The contract this variable is defined in, if any.

function: Option<FunctionId>

The function this variable is defined in, if any.

span: Span

The variable’s span.

kind: VarKind

The kind of variable.

ty: Type<'hir>

The variable’s type.

name: Option<Ident>

The variable’s name.

visibility: Option<Visibility>

The visibility of the variable.

mutability: Option<VarMut>

data_location: Option<DataLocation>

override_: bool

overrides: &'hir [ContractId]

indexed: bool

initializer: Option<&'hir Expr<'hir>>

getter: Option<FunctionId>

The compiler-generated getter function, if any.

Implementations

impl<'hir> Variable<'hir>

pub fn new( source: SourceId, ty: Type<'hir>, name: Option<Ident>, kind: VarKind, ) -> Variable<'hir>

Creates a new variable.

pub fn new_stmt( source: SourceId, contract: ContractId, function: FunctionId, ty: Type<'hir>, name: Ident, ) -> Variable<'hir>

Creates a new variable statement.

pub fn description(&self) -> &'static str

Returns the description of the variable.

pub fn is_constant(&self) -> bool

Returns true if the variable is constant.

pub fn is_immutable(&self) -> bool

Returns true if the variable is immutable.

pub fn is_l_value(&self) -> bool

pub fn is_struct_member(&self) -> bool

pub fn is_event_or_error_parameter(&self) -> bool

pub fn is_local_variable(&self) -> bool

pub fn is_callable_or_catch_parameter(&self) -> bool

pub fn is_local_or_return(&self) -> bool

pub fn is_return_parameter(&self) -> bool

pub fn is_try_catch_parameter(&self) -> bool

pub fn is_state_variable(&self) -> bool

Returns true if the variable is a state variable.

pub fn is_file_level_variable(&self) -> bool

pub fn is_public(&self) -> bool

Returns true if the variable is public.

Trait Implementations

impl<'hir> Debug for Variable<'hir>

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

Formats the value using the given formatter.