Struct FunctionSpec 

pub struct FunctionSpec {
    pub name: String,
    pub doc: Option<String>,
    pub params: Vec<ParamSpec>,
    pub return_type: Option<TypeRef>,
    pub is_async: bool,
    pub body: Vec<Statement>,
    pub visibility: Visibility,
    pub generics: Vec<GenericParam>,
    pub receiver: Option<Receiver>,
}

A declarative specification for a function or method.

Fields

name: String

Function name.

doc: Option<String>

Documentation comment.

params: Vec<ParamSpec>

Parameters.

return_type: Option<TypeRef>

Return type (None for void/unit).

is_async: bool

Whether this function is async.

body: Vec<Statement>

Function body as statements.

visibility: Visibility

Visibility modifier.

generics: Vec<GenericParam>

Generic type parameters.

receiver: Option<Receiver>

Whether this is a method (has self/this).

Implementations

impl FunctionSpec

pub fn new(name: impl Into<String>) -> Self

Create a new public function spec.

pub fn doc(self, doc: impl Into<String>) -> Self

Set documentation comment.

pub fn param(self, param: ParamSpec) -> Self

Add a parameter.

pub fn params(self, params: impl IntoIterator<Item = ParamSpec>) -> Self

Add multiple parameters.

pub fn returns(self, ty: TypeRef) -> Self

Set return type.

pub fn async_(self) -> Self

Mark as async.

pub fn statement(self, stmt: Statement) -> Self

Add a statement to the body.

pub fn statements(self, stmts: impl IntoIterator<Item = Statement>) -> Self

Add multiple statements to the body.

pub fn visibility(self, vis: Visibility) -> Self

Set visibility.

pub fn private(self) -> Self

Make this function private.

pub fn generic(self, param: GenericParam) -> Self

Add a generic type parameter.

pub fn receiver(self, recv: Receiver) -> Self

Set the receiver (makes this a method).

pub fn method(self) -> Self

Make this an immutable self method.

pub fn method_mut(self) -> Self

Make this a mutable self method.

pub fn has_body(&self) -> bool

Check if this function has a body.

Trait Implementations

impl Clone for FunctionSpec

fn clone(&self) -> FunctionSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionSpec

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

Formats the value using the given formatter.

impl PartialEq for FunctionSpec

fn eq(&self, other: &FunctionSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FunctionSpec