Struct syn_solidity::ItemFunction

pub struct ItemFunction {
    pub attrs: Vec<Attribute>,
    pub kind: FunctionKind,
    pub name: Option<SolIdent>,
    pub paren_token: Paren,
    pub arguments: ParameterList,
    pub attributes: FunctionAttributes,
    pub returns: Option<Returns>,
    pub body: FunctionBody,
}

A function, constructor, fallback, receive, or modifier definition: function helloWorld() external pure returns(string memory);.

Solidity reference: https://docs.soliditylang.org/en/latest/grammar.html#a4.SolidityParser.functionDefinition

Fields

attrs: Vec<Attribute>

The syn attributes of the function.

kind: FunctionKind

name: Option<SolIdent>

paren_token: Paren

arguments: ParameterList

attributes: FunctionAttributes

The Solidity attributes of the function.

returns: Option<Returns>

The optional return types of the function.

body: FunctionBody

Implementations

impl ItemFunction

pub fn new(kind: FunctionKind, name: Option<SolIdent>) -> Self

pub fn from_variable_definition(var: &VariableDefinition) -> Self

Creates a new function from a variable definition. The function will have the same name and the variable type’s will be the return type.

pub fn name(&self) -> &SolIdent

Returns the name of the function.

Panics

Panics if the function has no name. This is the case when kind is not Function.

pub fn is_void(&self) -> bool

Returns true if the function returns nothing.

pub fn has_implementation(&self) -> bool

Returns true if the function has a body.

pub fn call_type(&self) -> Type

Returns the function’s arguments tuple type.

pub fn return_type(&self) -> Option<Type>

Returns the function’s return tuple type.

pub fn body(&self) -> Option<&[Stmt]>

Returns a reference to the function’s body, if any.

pub fn body_mut(&mut self) -> Option<&mut Vec<Stmt>>

Returns a mutable reference to the function’s body, if any.

pub fn into_body(self) -> Result<Vec<Stmt>, Self>

Trait Implementations

impl Clone for ItemFunction

fn clone(&self) -> ItemFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ItemFunction

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

Formats the value using the given formatter.

impl Parse for ItemFunction

fn parse(input: ParseStream<'_>) -> Result<Self>

impl Spanned for ItemFunction

fn span(&self) -> Span

Returns the span of this syntax tree node.

fn set_span(&mut self, span: Span)

Sets the span of this syntax tree node.