rust/libcsp-rust
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity
6cf745c316
libcsp-rust/libcsp-sys
History
Robin Mueller 6cf745c316
try to fix libcsp-sys docs build
2024-06-01 20:27:41 +02:00
..
src final release preparations 2024-06-01 18:59:27 +02:00
templates Initial version of libcsp-rust 2024-06-01 17:48:49 +02:00
build.rs try to fix libcsp-sys docs build 2024-06-01 20:27:41 +02:00
Cargo.toml final release preparations 2024-06-01 18:59:27 +02:00
CHANGELOG.md Initial version of libcsp-rust 2024-06-01 17:48:49 +02:00
LICENSE-APACHE Initial version of libcsp-rust 2024-06-01 17:48:49 +02:00
NOTICE Initial version of libcsp-rust 2024-06-01 17:48:49 +02:00
README.md add badges for crates 2024-06-01 19:55:10 +02:00
release-checklist.md final release preparations 2024-06-01 18:59:27 +02:00

README.md

Crates.io docs.rs

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.