ashpd
| Crates.io | ashpd |
| lib.rs | ashpd |
| version | 0.10.2 |
| source | src |
| created_at | 2020-09-14 21:49:32.102832 |
| updated_at | 2024-11-01 16:19:26.211166 |
| description | XDG portals wrapper in Rust using zbus |
| homepage | |
| repository | https://github.com/bilelmoussaoui/ashpd |
| max_upload_size | |
| id | 288742 |
| size | 516,546 |
Bilal Elmoussaoui (bilelmoussaoui)
documentation
README
ASHPD
ASHPD, acronym of Aperture Science Handheld Portal Device is a Rust & zbus wrapper of the XDG portals DBus interfaces. The library aims to provide an easy way to interact with the various portals defined per the specifications. It provides an alternative to the C library https://github.com/flatpak/libportal
Examples
Ask the compositor to pick a color
use ashpd::desktop::Color;
async fn run() -> ashpd::Result<()> {
let color = Color::pick().send().await?.response()?;
println!("({}, {}, {})", color.red(), color.green(), color.blue());
Ok(())
}
Start a PipeWire stream from the user's camera
use ashpd::desktop::camera::Camera;
pub async fn run() -> ashpd::Result<()> {
let camera = Camera::new().await?;
if camera.is_present().await? {
camera.request_access().await?;
let remote_fd = camera.open_pipe_wire_remote().await?;
// pass the remote fd to GStreamer for example
}
Ok(())
}
Optional features
| Feature | Description | Default |
|---|---|---|
| tracing | Record various debug information using the tracing library |
No |
| tokio | Enable tokio runtime on zbus dependency | Yes |
| async-std | Enable the use of the async-std runtime | No |
| backend | unstable Enables APIs useful for writing portals implementations | No |
| glib | Make all the enums derive glib::Enum. Flags are not supported yet |
No |
| gtk4 | Implement From<Color> for gdk4::RGBA Provides WindowIdentifier::from_native that takes a IsA<gtk4::Native> |
No |
| gtk4_wayland | Provides WindowIdentifier::from_native that takes a IsA<gtk4::Native> with Wayland backend support only |
No |
| gtk4_x11 | Provides WindowIdentifier::from_native that takes a IsA<gtk4::Native> with X11 backend support only |
No |
| pipewire | Provides ashpd::desktop::camera::pipewire_streams that helps you retrieve the various camera streams associated with the retrieved file descriptor |
No |
| raw_handle | Provides WindowIdentifier::from_raw_handle and WindowIdentifier::as_raw_handle for raw-window-handle crate |
No |
| wayland | Provides WindowIdentifier::from_wayland for wayland-client crate |
No |
| backend | Enables portal backend implementation supoport | No |
Demo
The library comes with a demo built using the GTK 4 Rust bindings and previews most of the portals. It is meant as a test case for the portals (from a distributor perspective) and as a way for the developers to see which portals exists and how to integrate them into their application using ASHPD.
