rifgen

Crates.iorifgen
lib.rsrifgen
version0.1.7
sourcesrc
created_at2021-10-06 22:35:11.799153
updated_at2023-06-08 15:19:15.819304
descriptionffi Interface file generator. Use with flapigen
homepage
repositoryhttps://github.com/Kofituo/rifgen
max_upload_size
id461390
size69,248
Kofi Otuo (Kofituo)

documentation

README

rifgen

Rust doc Rust Documentation donate

Program for translating libraries written in Rust to interface files. It works with flapigen. For instructions on how to integrate with your project, click here. This crate was initially rust_interface_file_generator

Suppose you have the following Rust code:

struct Foo {
    data: i32
}

impl Foo {
    fn new(val: i32) -> Foo {
        Foo { data: val }
    }

    fn f(&self, a: i32, b: i32) -> i32 {
        self.data + a + b
    }

    fn set_field(&mut self, v: i32) {
        self.data = v;
    }
}

Using flapigen, you'd have to write an interface file similar to

foreign_class!(class Foo {
    self_type Foo;
    constructor Foo::new(_: i32) -> Foo;
    fn Foo::set_field(&mut self, _: i32);
    fn Foo::f(&self, _: i32, _: i32) -> i32;
});

in order to write in Java something like this:

Foo foo=new Foo(5);
        int res=foo.f(1,2);
        assert res==8;

or in C++ something like this:

Foo foo(5);
int res = foo.f(1, 2);
assert(res == 8);

This module generates the interface file, so you can focus more time on your code

Other Features:

✅ Fast and easy to use

✅ Specify style of the resulting code i.e. Whether CamelCase or snake_case

✅ Works, with structs, enums, trait

✅ You don't have to worry about the "order" in which code in the interface has to be

Users Guide

Read the rifgen users guide here!

View on crates.io

Contact Me

If you'd like to contact me to help with any project whatsoever, you can reach me on Upwork

Commit count: 98

cargo fmt