::safer_ffi

CI

See the user guide.

⚠️ WIP ⚠️

This is currently still being developed and at an experimental stage, hence its not being published to crates.io yet.

Prerequisites

Minimum Supported Rust Version: 1.43.0

Quickstart

Cargo.toml

Edit your Cargo.toml like so:

```toml [package] name = "crate_name" version = "0.1.0" edition = "2018"

[lib] crate-type = ["staticlib"]

[dependencies] safer-ffi = { git = "https://github.com/getditto/rust-saferffi.git", features = ["procmacros"] }

[features] c-headers = ["safer_ffi/headers"] ```

src/lib.rs

```rust use ::safer_ffi::prelude::*;

[derive_ReprC]

[repr(C)]

[derive(Debug, Clone, Copy)]

pub struct Point { x: f64, y: f64, }

[ffi_export]

fn midpoint ( left: &' Point, right: &'_ Point, ) -> Point { Point { x: (left.x + right.x) / 2., y: (left.y + right.y) / 2., } }

[ffi_export]

fn printpoint (point: &' Point) { println!("{:?}", point); }

[::saferffi::cfgheaders]

[test]

fn generateheaders () -> ::std::io::Result<()> { ::saferffi::headers::builder() .tofile("rustpoints.h")? .generate() } ```

Compilation & header generation

```shell

Compile the C library (in target/{debug,release}/libcrate_name.ext)

cargo build # --release

Generate the C header

cargo test --features c-headers -- generate_headers ```

Generated C header

``C /*! \file */ /******************************************* * * * File auto-generated by::safer_ffi`. * * * * Do not manually edit this file. * * * *************/

ifndef RUSTCRATENAME

define RUSTCRATENAME

ifdef __cplusplus

extern "C" {

endif

typedef struct { double x;

double y;

} Point_t;

Pointt midpoint ( Pointt const * left, Pointt const * right);

void printpoint ( Pointt const * point);

ifdef __cplusplus

} /* extern "C" */

endif

endif /* RUSTCRATENAME */

```

Testing it

main.c

```C

include

include "rust_points.h"

int main (int argc, char const * const argv[]) { Pointt a = { .x = 84, .y = 45 }; Pointt b = { .x = 0, .y = 39 }; Pointt m = midpoint(&a, &b); printpoint(&m); return EXITSUCCESS; } ```

Compilation command

```bash cc main.c -o main -L target/debug -l crate_name

Now feel free to run the compiled binary

./main ```

which outputs:

text Point { x: 42.0, y: 42.0 }