FunctionDefinition

std::meta::function_def contains methods on the built-in FunctionDefinition type representing a function definition in the source program.

Methods

name

name

fn name(self) -> Quoted {}

^{_{Source code: noir_stdlib/src/meta/function_def.nr#L3-L5}}

Returns the name of the function.

parameters

parameters

fn parameters(self) -> [(Quoted, Type)] {}

^{_{Source code: noir_stdlib/src/meta/function_def.nr#L8-L10}}

Returns each parameter of the function as a tuple of (parameter pattern, parameter type).

return_type

return_type

fn return_type(self) -> Type {}

^{_{Source code: noir_stdlib/src/meta/function_def.nr#L13-L15}}

The return type of the function.

set_body

set_body

fn set_body(self, body: Quoted) {}

^{_{Source code: noir_stdlib/src/meta/function_def.nr#L18-L20}}

Mutate the function body to a new expression. This is only valid on functions in the current crate which have not yet been resolved. This means any functions called at compile-time are invalid targets for this method.

Requires the new body to be a valid expression.

set_parameters

set_parameters

fn set_parameters(self, parameters: [(Quoted, Type)]) {}

^{_{Source code: noir_stdlib/src/meta/function_def.nr#L23-L25}}

Mutates the function's parameters to a new set of parameters. This is only valid on functions in the current crate which have not yet been resolved. This means any functions called at compile-time are invalid targets for this method.

Expects a slice of (parameter pattern, parameter type) for each parameter. Requires each parameter pattern to be a syntactically valid parameter.

set_return_type

set_return_type

fn set_return_type(self, return_type: Type) {}

^{_{Source code: noir_stdlib/src/meta/function_def.nr#L28-L30}}

Mutates the function's return type to a new type. This is only valid on functions in the current crate which have not yet been resolved. This means any functions called at compile-time are invalid targets for this method.