libcsp-rust/libcsp-sys

libcsp-sys

This crate provides FFI bindings for the libcsp library.

Generally, you probably do not want to use this library directly and instead use the libcsp Rust crate which provides a safe and ergonomic Rust API. You can find some more high-level information and examples in the main repository.

Compile-time configuration of the libcsp-rust library

The libcsp-rust library requires some compile-time configuration file to be included to work properly. You can see an example version of the file for the workspace here. The user has to provide the path to a directory containing this autoconfig.rs file using the CSP_CONFIG_DIR environmental variable.

It is recommended to read the main workspace README for more information to make the generation and specification of this auto-configuration file as conveniently and easy as possible.

Run unittests

Running unittests required the RUN_TESTS environmental variable to be set to 1. This is because the actual libcsp library might be built and linked in a separate crate, so the linker is not able to process -l csp when running the tests.

You can use

RUN_TESTS=1 cargo test

to run the unittests.