Struct zamm_yang::codegen::template::basic::FunctionFragment

pub struct FunctionFragment { /* fields omitted */ }

Fragment for a function.

Implementations

impl FunctionFragment

pub fn new(name: String) -> Self

Create a new function with the given name.

pub fn mark_as_test(&mut self)

Set the function to be a test function.

pub fn set_return(&mut self, return_type: String)

Set the return type for the function.

pub fn set_self_reference(&mut self, reference: SelfReference)

Set the self reference type for the function, if it's part of a struct or a trait.

pub fn add_arg(&mut self, name: String, arg_type: String)

Add a new argument to the function.

pub fn add_import(&mut self, import: String)

Add a new import for the args or return type.

pub fn append(&mut self, fragment: Rc<RefCell<dyn CodeFragment>>)

Add a fragment to the internals of this function.

Trait Implementations

impl CodeFragment for FunctionFragment

pub fn body(&self) -> String

Retrieve main body of code in this fragment.

pub fn imports(&self) -> Vec<String>

Retrieve all imports used by this fragment.

impl Default for FunctionFragment

pub fn default() -> Self

Returns the "default value" for a type.

impl ItemDeclarationAPI for FunctionFragment

pub fn mark_as_public(&mut self)

Mark this as a public declaration.

pub fn is_public(&self) -> bool

Whether this has been marked as a public declaration or not.

pub fn add_attribute(&mut self, attribute: String)

Add an attribute to the declaration.

pub fn document(&mut self, documentation: String)

Set the documentation for the fragment.

pub fn set_body(&mut self, body: Rc<RefCell<dyn CodeFragment>>)

Set an implementation to go along with the declaration.

pub fn mark_as_declare_only(&mut self)

Declares the item without implementing it.

pub fn mark_for_full_implementation(&mut self)

Mark the module as requiring full implementation, even if that implementation is an empty one.