Struct wrapgen::WrapperType

pub struct WrapperType<'a> {
    pub original: &'a str,
    pub renamed: &'a str,
    // some fields omitted
}

The representation of a pointer type to wrap. If you wrap a pointer type *mut T, it will be represtented as Wrapper<T> where Wrapper is defined as the following zero-cost abstraction:

pub struct Wrapper<T> {
    ptr: *mut T
}

impl<T> Wrapper<T> {
    pub fn from_ptr(ptr: *mut T) -> Self {
        Self { ptr }
    }

    pub fn get_ptr(&self) -> *mut T {
        self.ptr
    }
}

WrapGen can create methods to safely access fields present on *mut T.

Example

WrapperType::new("inode", "Inode")
   .with_field("i_sb", "*mut super_block")
   .with_field_writeonly("i_ino", "cty::c_int")

Fields

original: &'a str

renamed: &'a str

Implementations

impl<'a> WrapperType<'a>

pub fn new(original: &'a str, renamed: &'a str) -> Self

Create a new wrapper for type *mut original

pub fn with_field(self, field_name: &'a str, field_type: &'a str) -> Self

Add a field present on *mut original that has a getter and setter

pub fn with_field_readonly(
    self,
    field_name: &'a str,
    field_type: &'a str
) -> Self

Add a field present on *mut original that will only be read

pub fn with_field_writeonly(
    self,
    field_name: &'a str,
    field_type: &'a str
) -> Self

Add a field present on *mut original that will only be written to

pub fn generate(&self) -> String

Generate the implementation of the wrapper

Trait Implementations

impl<'a> Clone for WrapperType<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.