qemu-fw-cfg 0.2.0

A Rust library for reading fw_cfg from QEMU
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

# qemu-fw-cfg-rs

[![Crates.io](https://img.shields.io/crates/v/qemu-fw-cfg)](https://crates.io/crates/qemu-fw-cfg)
[![License-MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE-MIT)
[![License-Apache](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE-APACHE)
[![docs.rs](https://img.shields.io/docsrs/qemu-fw-cfg)](https://docs.rs/qemu-fw-cfg)

A Rust library for reading [fw_cfg] from QEMU.

[fw_cfg]: https://www.qemu.org/docs/master/specs/fw_cfg.html

## Usage

Add the following to your `Cargo.toml`:

```toml
[dependencies]
qemu-fw-cfg = "0.1"
```

To use `qemu-fw-cfg` without `alloc`, you can use this instead:

```toml
[dependencies]
qemu-fw-cfg = { version = "0.1", default-features = false }
```

## Examples

```rust
use qemu_fw_cfg::FwCfg;

// Verify that we are inside QEMU.
if running_in_qemu() {
    // Create a new `FwCfg` instance.
    let fw_cfg = unsafe { FwCfg::new().unwrap() };
    // Retrieve information of a file.
    let file = fw_cfg.find_file("etc/igd-opregion").unwrap();
    // Read data from the file.
    let data = fw_cfg.read_file(&file);
}
```

## Rust support

<!-- Keep this in sync with Cargo.toml and .github/workflows/ci.yml -->
The minimum supported Rust version for `qemu-fw-cfg` is 1.59.0.

However, testing for x86 currently requires Rust Nightly as it uses
[Cargo’s `build-std`](https://doc.rust-lang.org/cargo/reference/unstable.html#build-std).

## License

This project is licensed under either of [Apache License, Version 2.0](LICENSE-APACHE)
or [MIT license](LICENSE-MIT) at your option.