Struct Function

pub struct Function { /* private fields */ }

defines a C function

Implementations

impl Function

pub fn new(name: &str, ret: Type) -> Self

Creates a new function

pub fn with_string(name: String, ret: Type) -> Self

creates a new function with the given name and return type

pub fn name(&self) -> &str

returns the name of the method

pub fn to_type(&self) -> Type

obtains the type for this function

pub fn ret_type(&self) -> &Type

obtains a type reference of the return type

pub fn doc(&mut self, doc: Doc) -> &mut Self

Adds a new documentation to the function

pub fn push_doc_str(&mut self, doc: &str) -> &mut Self

Adds a new doc string to the function

pub fn new_param(&mut self, name: &str, ty: Type) -> &mut FunctionParam

creates a new parameter for the function

pub fn push_param(&mut self, item: FunctionParam) -> &mut Self

Push a param to the function’s parameters

pub fn param_by_name(&self, name: &str) -> Option<&FunctionParam>

obtains a reference to the param with the given name

pub fn param_by_name_mut(&mut self, name: &str) -> Option<&mut FunctionParam>

obtains a mutable reference to the param with the given name

pub fn param_by_idx(&self, idx: usize) -> Option<&FunctionParam>

obtains a reference to the param with the given index (starting at 0)

pub fn param_by_idx_mut(&mut self, idx: usize) -> Option<&mut FunctionParam>

obtains a mutable reference to the param with the given index mut

pub fn push_attribute(&mut self, attr: &str) -> &mut Self

adds a new attribute to the function

pub fn toggle_static(&mut self, val: bool) -> &mut Self

sets the function to be static

Example

void foo() -> static void foo()

pub fn set_static(&mut self) -> &mut Self

sets the function to be static

pub fn toggle_inline(&mut self, val: bool) -> &mut Self

sets the function to be inline

Example

void foo() -> inline void foo()

pub fn set_inline(&mut self) -> &mut Self

makes the function to be an inline method

pub fn toggle_extern(&mut self, val: bool) -> &mut Self

sets the function to be extern

Example

void foo() -> extern void foo()

pub fn set_extern(&mut self) -> &mut Self

makes the function to be an inline method

pub fn set_body(&mut self, body: Block) -> &mut Self

sets the body for the function

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

obtains a reference to the body of the function

pub fn do_fmt(&self, fmt: &mut Formatter<'_>, decl_only: bool) -> Result

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

formats the function definitions

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

formats only the function declaration

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

formats only the function definition

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl Display for Function

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

Formats the value using the given formatter.