flowbrigade Rust bindings

Rust bindings for FlowBrigade's experimental C ABI.

The Nim package remains the reference implementation. This crate is a thin, safe wrapper around the exported C ABI and intentionally starts with the stable subset already present in include/flowbrigade.h.

This crate requires Nim/Nimble at build time unless FLOWBRIGADE_LIB_DIR points to an existing native FlowBrigade library. See REQUIREMENTS.md for the full setup requirements.

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 the FlowBrigade core version are intentionally separate. The crate version tracks the Rust wrapper's own API stability, while the core version and C ABI version describe the native library it links to.

Installation

Install Nim and FlowBrigade first:

curl https://nim-lang.org/choosenim/init.sh -sSf | sh
nimble refresh
nimble install flowbrigade

Then add the Rust crate:

cargo add flowbrigade

During cargo build, this crate uses nimble path flowbrigade to find the installed Nim package, builds FlowBrigade's C ABI library into Cargo's build output directory, and links the Rust wrapper to it.

For local FlowBrigade development, point the binding at a checkout:

FLOWBRIGADE_SOURCE_DIR=/path/to/flowbrigade cargo test

If you already built the native library yourself, set FLOWBRIGADE_LIB_DIR to the directory containing libflowbrigade.so, libflowbrigade.dylib, or flowbrigade.dll.

Example

use std::time::Duration;

use flowbrigade::TokenBucket;

let mut bucket = TokenBucket::new(10, Duration::from_secs(1), 20)?;
let decision = bucket.consume(1)?;

assert!(decision.allowed);
# Ok::<(), flowbrigade::Error>(())

Implemented Surface