flowbrigade 0.1.4

Rust bindings for FlowBrigade's C ABI.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# Requirements

This crate is a Rust binding to FlowBrigade's Nim implementation.

It does not reimplement FlowBrigade in Rust. During `cargo build`, the build
script links the Rust wrapper to FlowBrigade's native C ABI library.

## Required By Default

- Rust and Cargo
- Nim
- Nimble
- FlowBrigade installed through Nimble
- A C compiler usable by Nim, such as `clang` or `gcc`

Install the Nim package before building a Rust project that depends on this
crate:

```sh
nimble refresh
nimble install flowbrigade
```

The build script then uses:

```sh
nimble path flowbrigade
```

to locate the installed Nim package and build the native C ABI library into
Cargo's build output directory.

## Local FlowBrigade Checkout

When developing against a local FlowBrigade checkout, set
`FLOWBRIGADE_SOURCE_DIR`:

```sh
FLOWBRIGADE_SOURCE_DIR=/path/to/flowbrigade cargo test
```

## Prebuilt Or Manually Built Native Library

If a native FlowBrigade library already exists, set `FLOWBRIGADE_LIB_DIR` to the
directory containing the library:

```sh
FLOWBRIGADE_LIB_DIR=/path/to/lib cargo test
```

The directory should contain one of:

- `libflowbrigade.so` on Linux
- `libflowbrigade.dylib` on macOS
- `flowbrigade.dll` on Windows

## Version Compatibility

`flowbrigade` Rust crate `0.1.4` targets FlowBrigade core `0.4.1` or later and
FlowBrigade C ABI version `2`.

The Rust crate version and FlowBrigade core version are intentionally separate.