xref: /qemu/rust/qemu-api/README.md (revision 1eec82cc06cd68b6ffaf13ba8337fac0080c7bce)
15a5110d2SManos Pitsidianakis# QEMU bindings and API wrappers
25a5110d2SManos Pitsidianakis
35a5110d2SManos PitsidianakisThis library exports helper Rust types, Rust macros and C FFI bindings for internal QEMU APIs.
45a5110d2SManos Pitsidianakis
55a5110d2SManos PitsidianakisThe C bindings can be generated with `bindgen`, using this build target:
65a5110d2SManos Pitsidianakis
75a5110d2SManos Pitsidianakis```console
8*cab1d0bcSPaolo Bonzini$ make bindings.inc.rs
95a5110d2SManos Pitsidianakis```
105a5110d2SManos Pitsidianakis
115a5110d2SManos Pitsidianakis## Generate Rust documentation
125a5110d2SManos Pitsidianakis
13*cab1d0bcSPaolo BonziniCommon Cargo tasks can be performed from the QEMU build directory
145a5110d2SManos Pitsidianakis
15*cab1d0bcSPaolo Bonzini```console
16*cab1d0bcSPaolo Bonzini$ make clippy
17*cab1d0bcSPaolo Bonzini$ make rustfmt
18*cab1d0bcSPaolo Bonzini$ make rustdoc
195a5110d2SManos Pitsidianakis```
20