2024-06-01 01:14:40 +02:00
|
|
|
libcsp-rust
|
|
|
|
|
========
|
|
|
|
|
|
2024-06-01 12:20:07 +02:00
|
|
|
This crate provides a (mostly) safe and ergonomic Rust API for the
|
|
|
|
|
[`libcsp` library](https://github.com/libcsp/libcsp) on top of the `libcsp-sys`
|
|
|
|
|
crate. You can find some more high-level information and examples in the
|
|
|
|
|
[main repository](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust).
|
2024-06-01 01:14:40 +02:00
|
|
|
|
|
|
|
|
The API documentation should provide all additional information required to use this library.
|
|
|
|
|
|
|
|
|
|
## 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](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/examples/autoconfig.rs).
|
|
|
|
|
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](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust)
|
|
|
|
|
for more information to make the generation and specification of this auto-configuration file
|
|
|
|
|
as conveniently and easy as possible.
|
