Skip to content

zachcmadsen/rtrb-capi

Repository files navigation

rtrb-capi

CI

A C API for rtrb, a thread-safe SPSC ring buffer written in Rust.

The C API only covers part of rtrb's API.

Documentation

The API is documented in include/rtrb.h.

See rtrb-capi-example for an example C++ project that uses rtrb-capi.

Usage

You need Rust and Cargo installed to build rtrb-capi.

If your project uses CMake, then you can include rtrb-capi with FetchContent:

include(FetchContent)
FetchContent_Declare(
    rtrb
    URL https://github.com/zachcmadsen/rtrb-capi/releases/download/v0.1.1/rtrb-src.tar.gz
)
FetchContent_MakeAvailable(rtrb)

add_executable(rtrb-example)
target_sources(rtrb-example PRIVATE main.cpp)
target_link_libraries(rtrb-example PRIVATE rtrb::rtrb)