Struct binary_util::Function

pub struct Function { /* private fields */ }

Defines a function.

Implementations

impl Function

pub fn new(name: &str) -> Function

Return a new function definition.

pub fn doc(&mut self, docs: &str) -> &mut Function

Set the function documentation.

pub fn allow(&mut self, allow: &str) -> &mut Function

Specify lint attribute to supress a warning or error.

pub fn vis(&mut self, vis: &str) -> &mut Function

Set the function visibility.

pub fn set_async(&mut self, async: bool) -> &mut Function

Set whether this function is async or not

pub fn generic(&mut self, name: &str) -> &mut Function

Add a generic to the function.

pub fn arg_self(&mut self) -> &mut Function

Add self as a function argument.

pub fn arg_ref_self(&mut self) -> &mut Function

Add &self as a function argument.

pub fn arg_mut_self(&mut self) -> &mut Function

Add &mut self as a function argument.

pub fn arg<T>(&mut self, name: &str, ty: T) -> &mut Functionwhere T: Into<Type>,

Add a function argument.

pub fn ret<T>(&mut self, ty: T) -> &mut Functionwhere T: Into<Type>,

Set the function return type.

pub fn bound<T>(&mut self, name: &str, ty: T) -> &mut Functionwhere T: Into<Type>,

Add a where bound to the function.

pub fn line<T>(&mut self, line: T) -> &mut Functionwhere T: ToString,

Push a line to the function implementation.

pub fn attr(&mut self, attribute: &str) -> &mut Function

Add an attribute to the function.

use codegen::Function;

let mut func = Function::new("test");

// add a `#[test]` attribute
func.attr("test");

pub fn extern_abi(&mut self, abi: &str) -> &mut Function

Specify an extern ABI for the function.

use codegen::Function;

let mut extern_func = Function::new("extern_func");

// use the "C" calling convention
extern_func.extern_abi("C");

pub fn push_block(&mut self, block: Block) -> &mut Function

Push a block to the function implementation

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

Formats the function using the given formatter.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy 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<(), Error>

Formats the value using the given formatter.