A Rust implementation of the KDE/freedesktop StatusNotifierItem specification
use ksni::TrayMethods; // provides the spawn method
#[derive(Debug)]
struct MyTray {
selected_option: usize,
checked: bool,
}
impl ksni::Tray for MyTray {
fn id(&self) -> String {
env!("CARGO_PKG_NAME").into()
}
fn icon_name(&self) -> String {
"help-about".into()
}
fn title(&self) -> String {
if self.checked { "CHECKED!" } else { "MyTray" }.into()
}
fn menu(&self) -> Vec<ksni::MenuItem<Self>> {
use ksni::menu::*;
vec![
SubMenu {
label: "a".into(),
submenu: vec![
SubMenu {
label: "a1".into(),
submenu: vec![
StandardItem {
label: "a1.1".into(),
..Default::default()
}
.into(),
StandardItem {
label: "a1.2".into(),
..Default::default()
}
.into(),
],
..Default::default()
}
.into(),
StandardItem {
label: "a2".into(),
..Default::default()
}
.into(),
],
..Default::default()
}
.into(),
MenuItem::Separator,
RadioGroup {
selected: self.selected_option,
select: Box::new(|this: &mut Self, current| {
this.selected_option = current;
}),
options: vec![
RadioItem {
label: "Option 0".into(),
..Default::default()
},
RadioItem {
label: "Option 1".into(),
..Default::default()
},
RadioItem {
label: "Option 2".into(),
..Default::default()
},
],
..Default::default()
}
.into(),
CheckmarkItem {
label: "Checkable".into(),
checked: self.checked,
activate: Box::new(|this: &mut Self| this.checked = !this.checked),
..Default::default()
}
.into(),
StandardItem {
label: "Exit".into(),
icon_name: "application-exit".into(),
activate: Box::new(|_| std::process::exit(0)),
..Default::default()
}
.into(),
]
}
}
#[tokio::main(flavor = "current_thread")]
async fn main() {
let tray = MyTray {
selected_option: 0,
checked: false,
};
let handle = tray.spawn().await.unwrap();
tokio::time::sleep(std::time::Duration::from_secs(5)).await;
// We can modify the tray
handle.update(|tray: &mut MyTray| tray.checked = true).await;
// Run forever
std::future::pending().await
}Will create a system tray like this:
(In GNOME with AppIndicator extension)
ksni uses Tokio by default, but can be runtime-agnostic by disabling the "tokio" feature and enabling the "async-io" feature
[dependencies]
ksni = { version = "0.3", default-features = false, features = ["async-io"] }The zbus dependency has a known issue (z-galaxy/zbus#526) that can cause a runtime panic in certain dependency tree configurations.
The panic occurs only if all of the following conditions are met:
- A crate in your dependency tree enables the
zbus/tokiofeature (e.g.,ksniwith the default features). - Another crate in your dependency tree does not enable the
zbus/tokiofeature. - The crate from step 2 runs
zbusin its own executor (this usually happens when an async crate provides a blocking API that is being used; a purely blocking crate usingzbus::blockingdirectly is not affected).
If you can confirm that the situation described above does not exist, keep the default features.
This is the preferred approach as it reduces your dependency tree size (See Cargo.toml)
and avoids spawning an additional executor thread.
Otherwise, disable default-features and use the async-io. It makes ksni runtime-agnostic and works seamlessly even if your main application is running on top of Tokio.
Enable the "blocking" feature in Cargo.toml to get a non-async API
[dependencies]
ksni = { version = "0.3", features = ["blocking"] }Protocol tests require cargo-nextest and dbus-run-session (provided by the
dbus package on most distributions). The nextest configuration in
.config/nextest.toml automatically wraps each test in an isolated D-Bus session.
cargo nextest run- org.kde.StatusNotifierItem
- com.canonical.dbusmenu
- org.freedesktop.DBus.Introspectable
- org.freedesktop.DBus.Properties
- radio item
- documents
- async
diwic/dbus-rs#166edit: zbus now - mutable menu items
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.