1
0
mirror of https://gitlab.com/marcandre.lureau/qemu-display.git synced 2025-04-14 08:44:46 +00:00
Marc-André Lureau e79f0dc751 qemu-display: prepare for initial release
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
2025-01-15 12:46:41 +04:00

2.0 KiB

QEMU -display dbus library

Crates.io Documentation License

Provides convenient APIs to communicate with qemu -display dbus from Rust.

Features

  • provides all common D-Bus interfaces by default
  • provides "unix" and "win32" specific interfaces on respective targets
  • optional "qmp" feature, to allow connecting to QEMU via p2p / bus-less.

Installation

Add this to your Cargo.toml:

[dependencies]
qemu-display = "0.1.0"

Quick Start

Here's a simple example of how to use the library:

use qemu_display::Display;
use zbus::Connection;

#[async_std::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let conn = Connection::session().await?;
    let display = Display::new::<()>(&conn, None).await?;
    // TODO: complete this example
    Ok(())
}

API Documentation

For detailed API documentation, please visit docs.rs/qemu-display.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Development Setup

  1. Clone the repository:
git clone https://gitlab.com/marcandre.lureau/qemu-display
cd qemu-display/qemu-display
  1. Build the project:
cargo build
  1. Run tests:
cargo test

Changelog

[0.1.0] - 2025-01-15

  • Initial release

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Thanks to contributors
  • Credit to Rust, QEMU and zbus
  • Red Hat!

Contact


Built with ❤️ using Rust