# qapi-rs

[![release-badge][]][cargo] [![docs-badge][]][docs] [![license-badge][]][license]

A rust library for interfacing with [QEMU](https://www.qemu.org/) QAPI sockets.

## [Documentation][docs]

See the [documentation][docs] for up to date information, as well as the
reference documentation for both the [QEMU Machine Protocol](https://qemu-project.gitlab.io/qemu/interop/qemu-qmp-ref.html)
and [Guest Agent](https://qemu-project.gitlab.io/qemu/interop/qemu-ga-ref.html) APIs.

There are two features (`qga` and `qmp`) which enable their respective functionality.
They can be enabled in your `Cargo.toml`:

```toml
[dependencies]
qapi = { version = "0.15", features = [ "qmp" ] }
```

### Examples

Short examples are available for both [QMP](examples/src/bin/qmp_query.rs) and [Guest
Agent](examples/src/bin/guest_info.rs). Async/nonblocking examples using tokio [are also
available](examples/src/bin/tokio_qmp_query.rs).

[release-badge]: https://img.shields.io/crates/v/qapi.svg?style=flat-square
[cargo]: https://crates.io/crates/qapi
[docs-badge]: https://img.shields.io/badge/API-docs-blue.svg?style=flat-square
[docs]: https://docs.rs/qapi/
[license-badge]: https://img.shields.io/badge/license-MIT-ff69b4.svg?style=flat-square
[license]: https://github.com/arcnmx/qapi-rs/blob/master/COPYING