summaryrefslogtreecommitdiff
path: root/rust/README.md
blob: 3a899cef68d467519b4414c6fe7828c376e34e6c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# Rust bindings for vboot_reference

This path contains the vboot_reference-sys crate which uses bindgen to generate
Rust bindings for the vboot_reference C library.

Each header is included as its own submodule. To use these bindings:
 * Add `vboot_reference-sys` to your `Cargo.toml` for example:
```toml
[dependencies]
vboot_reference-sys = { path = "../../vboot_reference/rust/vboot_reference-sys" }
```
 * Include the symbols you need for example:
```rust
use vboot_reference_sys::crossystem::*;
```

The `build.rs` in `vboot_reference-sys` takes care of adding the necessary
includes and linker flags for `vboot_host` through the `pkg-config` crate.