Struct wrapgen::WrapGen

pub struct WrapGen<'a> { /* fields omitted */ }

The builder struct to create wrappers. Create an instance, add the files, types and functions you want to wrap and finally call generate() to create the wrappers.

Examples

Wrap some functions

WrapGen::new("examples/to_wrap.rs").generate("outfile.rs");

Wrap a pointer type

WrapGen::default()
        .wrap_pointer_type(
            WrapperType::new("inode", "Inode")
                .with_field("i_sb", "*mut super_block")
                .with_field_writeonly("i_ino", "cty::c_int"),
        )
        .generate("outfile.rs")

Implementations

impl<'a> WrapGen<'a>

pub fn default() -> Self

Create a new WrapGen without reading from any files

pub fn add_file<P: AsRef<Path>>(self, file: P) -> Self

Add all the functions from file

pub fn add_function(self, function: &'a str) -> Self

Add the single function from function. A semicolon at the end is optional here.

pub fn prefix(self, prefix: &'a str) -> Self

Set the prefix of the wrapped functions. Defaults to rs_

pub fn use_core(self, use_core: bool) -> Self

Determines if core::ptr or std::ptr should be used

pub fn new<P: AsRef<Path>>(file: P) -> Self

Create a new WrapGen and add the functions listed in file

pub fn wrap_pointer_type(self, to_wrap: WrapperType<'a>) -> Self

Will create a wrapper around a type (usually a pointer) to allow safe access to fields

pub fn generate<P: AsRef<Path>>(&'a mut self, outfile_path: P)

Generate wrappers for all previously added functions and write them to outfile_path

Trait Implementations

impl<'a> Clone for WrapGen<'a>

fn clone(&self) -> WrapGen<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.