Struct FunctionStatement 

pub struct FunctionStatement { /* private fields */ }

Represents a function declaration statement.

Implementations

impl FunctionStatement

pub fn new( name: FunctionName, block: Block, parameters: Vec<TypedIdentifier>, is_variadic: bool, ) -> Self

Creates a new function statement with the given name, block, parameters, and variadic flag.

pub fn from_name<S: Into<String>, B: Into<Block>>(name: S, block: B) -> Self

Creates a new function statement from a single identifier and a block.

pub fn with_tokens(self, tokens: FunctionBodyTokens) -> Self

Sets the tokens for this function statement.

pub fn set_tokens(&mut self, tokens: FunctionBodyTokens)

Sets the tokens for this function statement.

pub fn get_tokens(&self) -> Option<&FunctionBodyTokens>

Returns the tokens for this function statement, if any.

pub fn mutate_tokens(&mut self) -> Option<&mut FunctionBodyTokens>

Returns a mutable reference to the tokens, if any.

pub fn with_parameter(self, parameter: impl Into<TypedIdentifier>) -> Self

Adds a parameter to this function.

pub fn variadic(self) -> Self

Marks this function as variadic.

pub fn with_variadic_type(self, type: impl Into<FunctionVariadicType>) -> Self

Sets the variadic type for this function.

pub fn set_variadic_type(&mut self, type: impl Into<FunctionVariadicType>)

Sets the variadic type for this function.

pub fn get_variadic_type(&self) -> Option<&FunctionVariadicType>

Returns the variadic type, if any.

pub fn has_variadic_type(&self) -> bool

Returns whether this function has a variadic type.

pub fn mutate_variadic_type(&mut self) -> Option<&mut FunctionVariadicType>

Returns a mutable reference to the variadic type, if any.

pub fn with_return_type( self, return_type: impl Into<FunctionReturnType>, ) -> Self

Sets the return type for this function.

pub fn set_return_type(&mut self, return_type: impl Into<FunctionReturnType>)

Sets the return type for this function.

pub fn get_return_type(&self) -> Option<&FunctionReturnType>

Returns the return type, if any.

pub fn has_return_type(&self) -> bool

Returns whether this function has a return type.

pub fn mutate_return_type(&mut self) -> Option<&mut FunctionReturnType>

Returns a mutable reference to the return type, if any.

pub fn with_generic_parameters( self, generic_parameters: GenericParameters, ) -> Self

Sets the generic parameters for this function.

pub fn set_generic_parameters(&mut self, generic_parameters: GenericParameters)

Sets the generic parameters for this function.

pub fn get_generic_parameters(&self) -> Option<&GenericParameters>

Returns the generic parameters, if any.

pub fn get_block(&self) -> &Block

Returns a reference to the function’s block.

pub fn get_name(&self) -> &FunctionName

Returns a reference to the function’s name.

pub fn parameters_count(&self) -> usize

Returns the number of parameters in this function.

pub fn get_parameters(&self) -> &Vec<TypedIdentifier>

Returns a reference to the function’s parameters.

pub fn iter_parameters(&self) -> impl Iterator<Item = &TypedIdentifier>

Returns an iterator over the function’s parameters.

pub fn iter_mut_parameters( &mut self, ) -> impl Iterator<Item = &mut TypedIdentifier>

Returns a mutable iterator over the function’s parameters.

pub fn is_variadic(&self) -> bool

Returns whether this function is variadic.

pub fn mutate_block(&mut self) -> &mut Block

Returns a mutable reference to the function’s block.

pub fn mutate_function_name(&mut self) -> &mut FunctionName

Returns a mutable reference to the function’s name.

pub fn mutate_parameters(&mut self) -> &mut Vec<TypedIdentifier>

Returns a mutable reference to the function’s parameters.

pub fn remove_method(&mut self)

Removes the method from the function name and adds it as a field, inserting ‘self’ as the first parameter.

If the method is not present, this does nothing.

pub fn has_parameters(&self) -> bool

Returns whether this function has any parameters.

pub fn clear_types(&mut self)

Removes all type information from the function, including return type, variadic type, generic parameters, and parameter types.

pub fn mutate_first_token(&mut self) -> &mut Token

Returns a mutable reference to the first token for this statement, creating it if missing.

pub fn mutate_last_token(&mut self) -> &mut Token

Returns a mutable reference to the last token for this statement, creating it if missing.

pub fn clear_comments(&mut self)

Clears all comments from the tokens in this node.

pub fn clear_whitespaces(&mut self)

Clears all whitespaces information from the tokens in this node.

Trait Implementations

impl Clone for FunctionStatement

fn clone(&self) -> FunctionStatement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionStatement

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

Formats the value using the given formatter.

impl From<FunctionStatement> for Statement

fn from(function: FunctionStatement) -> Statement

Converts to this type from the input type.

impl PartialEq for FunctionStatement

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

impl StructuralPartialEq for FunctionStatement