Struct foundry_compilers::artifacts::ast::FunctionDefinition

pub struct FunctionDefinition {

    pub id: usize,
    pub src: SourceLocation,
    pub name: String,
    pub name_location: Option<SourceLocation>,
    pub base_functions: Vec<usize>,
    pub body: Option<Block>,
    pub documentation: Option<StructuredDocumentation>,
    pub function_selector: Option<String>,
    pub implemented: bool,
    pub modifiers: Vec<ModifierInvocation>,
    pub overrides: Option<OverrideSpecifier>,
    pub parameters: ParameterList,
    pub return_parameters: ParameterList,
    pub scope: usize,
    pub visibility: Visibility,
    pub kind: Option<FunctionKind>,
    pub state_mutability: Option<StateMutability>,
    pub is_virtual: bool,
    pub is_constructor: bool,
    pub is_declared_const: bool,
    pub is_payable: bool,
}

A function definition.

Fields

id: usize

src: SourceLocation

name: String

name_location: Option<SourceLocation>

base_functions: Vec<usize>

body: Option<Block>

documentation: Option<StructuredDocumentation>

function_selector: Option<String>

implemented: bool

modifiers: Vec<ModifierInvocation>

overrides: Option<OverrideSpecifier>

parameters: ParameterList

return_parameters: ParameterList

scope: usize

visibility: Visibility

kind: Option<FunctionKind>

The kind of function this node defines. Only valid for Solidity versions 0.5.x and above.

For cross-version compatibility use FunctionDefinition::kind().

state_mutability: Option<StateMutability>

The state mutability of the function.

Note: This was introduced in Solidity 0.5.x. For cross-version compatibility use FunctionDefinition::state_mutability().

is_virtual: bool

is_constructor: bool

Whether or not this function is the constructor. Only valid for Solidity versions below 0.5.x.

After 0.5.x you must use kind. For cross-version compatibility use FunctionDefinition::kind().

is_declared_const: bool

Whether or not this function is constant (view or pure). Only valid for Solidity versions below 0.5.x.

After 0.5.x you must use state_mutability. For cross-version compatibility use FunctionDefinition::state_mutability().

is_payable: bool

Whether or not this function is payable. Only valid for Solidity versions below 0.5.x.

After 0.5.x you must use state_mutability. For cross-version compatibility use FunctionDefinition::state_mutability().

Implementations

impl FunctionDefinition

pub fn kind(&self) -> &FunctionKind

The kind of function this node defines.

pub fn state_mutability(&self) -> &StateMutability

The state mutability of the function.

Note: Before Solidity 0.5.x, this is an approximation, as there was no distinction between view and pure.

Trait Implementations

impl Clone for FunctionDefinition

fn clone(&self) -> FunctionDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunctionDefinition

fn eq(&self, other: &FunctionDefinition) -> 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 FunctionDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FunctionDefinition

impl StructuralEq for FunctionDefinition

impl StructuralPartialEq for FunctionDefinition