Struct Function

pub struct Function<'hir> {

    pub source: SourceId,
    pub contract: Option<ContractId>,
    pub span: Span,
    pub name: Option<Ident>,
    pub kind: FunctionKind,
    pub visibility: Visibility,
    pub state_mutability: StateMutability,
    pub modifiers: &'hir [Modifier<'hir>],
    pub marked_virtual: bool,
    pub virtual_: bool,
    pub override_: bool,
    pub overrides: &'hir [ContractId],
    pub parameters: &'hir [VariableId],
    pub returns: &'hir [VariableId],
    pub body: Option<Block<'hir>>,
    pub body_span: Span,
    pub gettee: Option<VariableId>,
}

A function.

Fields

source: SourceId

The source this function is defined in.

contract: Option<ContractId>

The contract this function is defined in, if any.

span: Span

The function span.

name: Option<Ident>

The function name. Only None if this is a constructor, fallback, or receive function.

kind: FunctionKind

The function kind.

visibility: Visibility

The visibility of the function.

state_mutability: StateMutability

The state mutability of the function.

modifiers: &'hir [Modifier<'hir>]

Modifiers, or base classes if this is a constructor.

marked_virtual: bool

Whether this function is marked with the virtual keyword.

virtual_: bool

Whether this function is marked with the virtual keyword or is defined in an interface.

override_: bool

Whether this function is marked with the override keyword.

overrides: &'hir [ContractId]

parameters: &'hir [VariableId]

The function parameters.

returns: &'hir [VariableId]

The function returns.

body: Option<Block<'hir>>

The function body.

body_span: Span

The function body span.

gettee: Option<VariableId>

The variable this function is a getter of, if any.

Implementations

impl Function<'_>

pub fn keyword_span(&self) -> Span

Returns the span of the kind keyword.

pub fn is_free(&self) -> bool

Returns true if this is a free function, meaning it is not part of a contract.

pub fn is_ordinary(&self) -> bool

pub fn is_getter(&self) -> bool

Returns true if this is a getter function of a variable.

pub fn is_part_of_external_interface(&self) -> bool

pub fn is_special(&self) -> bool

Returns true if this is a receive or fallback function

pub fn is_constructor(&self) -> bool

Returns true if this is a constructor

pub fn mutates_state(&self) -> bool

Returns true if this function mutates state

pub fn variables( &self, ) -> impl DoubleEndedIterator<Item = VariableId> + Clone + use<'_>

Returns an iterator over all variables in the function.

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

Returns the description of the function.

Trait Implementations

impl<'hir> Debug for Function<'hir>

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

Formats the value using the given formatter.