24 releases

0.3.1 Sep 11, 2023
0.3.0 May 25, 2023
0.2.12 Jan 2, 2023
0.2.11 Aug 29, 2019
0.2.7 Jun 6, 2017

#12 in Emulators

Download history 5/week @ 2024-02-12 19/week @ 2024-02-19 64/week @ 2024-02-26 37/week @ 2024-03-04 58/week @ 2024-03-11 48/week @ 2024-03-18 15/week @ 2024-03-25 115/week @ 2024-04-01 72/week @ 2024-04-08 182/week @ 2024-04-15 72/week @ 2024-04-22 70/week @ 2024-04-29 65/week @ 2024-05-06 89/week @ 2024-05-13 71/week @ 2024-05-20 71/week @ 2024-05-27

304 downloads per month
Used in 2 crates

LGPL-2.1

480KB
12K SLoC

This crate provides a Rust bindings to the libvirt C library

The bindings try to be a direct mapping of the underling C API with some differences to match Rust conventions.

Important considerations

Make sure the libvirt-dev or libvirt-devel package is installed (or that the development files are in your include path).

The bindings do not implement all of what the C library is providing but we do consider the current API quite stable.

The bindings use standard errors handling from Rust. Each method (there are some exceptions) returns a type Option or Result.

Optional features

  • qemu allows using libvirt-qemu functions, such as qemu_monitor_command.

  • bindgen_regenerate uses the bindgen crate to generate a Rust-compatible representation of the C API. The output for a recent version of libvirt is already included in the repository, so only maintainers should ever need to use this feature.

Documentation

To execute locally tests and other excerices

cargo fmt -v -- --check

The code is formatted using rustfmt, you should ensure that the check is passing before to submit your patch(es). It may be required to execute rustup component add rustfmt in your environment.

cargo test --verbose

Integration tests use a real connection to libvirtd. For instance integration_qemu.rs uses a qemu:///system connection. They are all ignored by default.

cargo test --verbose -- --ignored

Similar to libvirt-go-module, the integration tests also require that libvirtd listens on localhost with sasl auth. This can be setup by editing /etc/libvirt/libvirtd.conf as follows:

  listen_tls=0
  listen_tcp=1
  auth_tcp=sasl
  listen_addr="127.0.0.1"

and starting libvirtd with the --listen flag (this can be set in /etc/sysconfig/libvirtd to make it persistent).

Then create a sasl user

saslpasswd2 -a libvirt user

and enter "pass" as the password.

To run examples

# cargo run --example hello
# cargo run --example migrate -- qemu:///system tcp+qemu://192.168.0.1/system myguest

Contributing

The libvirt project aims to add support for new APIs to libvirt-rs as soon as they are added to the main libvirt C library. If you are submitting changes to the libvirt C library API, please submit a libvirt-rs change at the same time.

For more information, see the CONTRIBUTING file.

The list of missing methods can be displayed with:

$ python tools/api_tests.py virDomain
{'file': 'libvirt-domain', 'name': 'virDomainMigrateSetMaxSpeed', 'module': 'libvirt-domain'}
{'file': 'libvirt-domain', 'name': 'virDomainRef', 'module': 'libvirt-domain'}
{'file': 'libvirt-domain', 'name': 'virDomainGetMemoryParameters', 'module': 'libvirt-domain'}
...

Dependencies