Adding `wayle_niri` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add wayle-niri

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

wayle-niri = "0.1.0"

The wayle_niri library will be automatically available globally. Read the wayle_niri library documentation.

Back to the crate overview.

Readme

Wayle

wayle-niri

Reactive bindings to the niri compositor via IPC.

cargo add wayle-niri

Usage

NiriService connects to niri's IPC socket (from $NIRI_SOCKET), subscribes to the event stream, and exposes the current window / workspace state through Property<T> fields.

use wayle_niri::NiriService;
use futures::StreamExt;

async fn example() -> wayle_niri::Result<()> {
    let service = NiriService::new().await?;

    for workspace in service.workspaces.get().values() {
        println!("workspace {} on {:?}", workspace.id.get(), workspace.output.get());
    }

    let mut focused = service.focused_window_id.watch();
    while let Some(window_id) = focused.next().await {
        println!("focused window id: {window_id:?}");
    }
    Ok(())
}

Actions

Send typed actions through the same service instance. action(Action) is the generic entry point; convenience wrappers cover the common cases.

use wayle_niri::{NiriService, WorkspaceReferenceArg};

async fn switch_and_spawn(service: &NiriService) -> wayle_niri::Result<()> {
    service.focus_workspace(WorkspaceReferenceArg::Index(2)).await?;
    service.spawn(vec!["alacritty".into()]).await?;
    Ok(())
}

License

MIT

Part of wayle-services.

Adding wayle_niri library as a dependency

Adding `wayle_niri` library as a dependency