Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hoodie/notify-rust
☝️send desktop notifications from your Rust app.
https://github.com/hoodie/notify-rust
convenience desktop-notifications linux macos xdg
Last synced: 15 days ago
JSON representation
☝️send desktop notifications from your Rust app.
- Host: GitHub
- URL: https://github.com/hoodie/notify-rust
- Owner: hoodie
- License: apache-2.0
- Created: 2015-05-20T22:29:24.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T22:40:33.000Z (16 days ago)
- Last Synced: 2024-10-28T02:26:29.870Z (16 days ago)
- Topics: convenience, desktop-notifications, linux, macos, xdg
- Language: Rust
- Homepage:
- Size: 771 KB
- Stars: 1,148
- Watchers: 8
- Forks: 74
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-Apache
Awesome Lists containing this project
README
# notify-rust
[](https://github.com/hoodie/notify-rust/actions?query=workflow%3A"Continuous+Integration")
[](https://crates.io/crates/notify-rust)
[](https://github.com/hoodie/notify-rust/graphs/contributors)
[](https://crates.io/crates/notify-rust/)
[](https://docs.rs/notify-rust/)
[](https://crates.io/crates/notify-rust/)
A not so well-named library for displaying desktop notifications.
```toml
[dependencies]
notify-rust = "4"
```
## Usage & Documentation
Please see the [documentation](https://docs.rs/crate/notify-rust/) for current examples.
### Simple Notification
```rust
use notify_rust::Notification;
Notification::new()
.summary("Firefox News")
.body("This will almost look like a real firefox notification.")
.icon("firefox")
.show()?;
```
### Persistent Notification
```rust
use notify_rust::{Notification, Hint};
Notification::new()
.summary("Category:email")
.body("This has nothing to do with emails.\nIt should not go away until you acknowledge it.")
.icon("thunderbird")
.appname("thunderbird")
.hint(Hint::Category("email".to_owned()))
.hint(Hint::Resident(true)) // this is not supported by all implementations
.timeout(0) // this however is
.show()?;
```
## Linux/BSD support
The main audience of this library are Linux/BSD based desktop environments that follow the XDG specification (see [gnome dev docs](http://web.archive.org/web/20200606201408/https://developer.gnome.org/notification-spec/) or [libnotify docs](https://www.galago-project.org/specs/notification/0.9/index.html)). These include KDE, Gnome, XFCE, LXDC, Mate (and probably also most others that I haven't personally tested).
### Features
#### `images`
Enables sending of images with notifications. This is only supported on XDG. This will add the [**image** crate](https://lib.rs/image) as a dependency as well as [**lazy_static**](https://lib.rs/lazy_static) to determine the supported spec spec-version on startup.
#### `d`
Enables the usage of [**dbus-rs**](https://lib.rs/dbus) instead of [**zbus**](https://lib.rs/zbus) (also XDG only).
This is functionally identical to the default feature set.
**As long as you still compile with default-features this will only enable dbus-rs usage, but not default to it!** In order to use the dbus-rs implementation set the environment variable **`DBUSRS `** or compile notify-rust with **`--no-default-features`**.
## macOS support
This library shines on linux and bsd, which is its original target platform.
Lately it gained support for macOS thanks to [mac-notification-sys](https://crates.io/crates/mac-notification-sys).
However this only includes a small subset of the current functionality, since [`NSNotification`](https://developer.apple.com/reference/foundation/nsnotification)s don't have as many features.
**call for participation:** You are a versed macOS UI developer with mad Objective-C skillz? PRSV.
## Windows support
Similar to macOS we support windows via the help of [winrt-notification](https://crates.io/crates/winrt-notification).
## Commandline tool
Checkout [toastify](https://github.com/hoodie/toastify), it exposes most of the functionality of the lib to the commandline.
## Contribution
Any help in form of descriptive and friendly [issues](https://github.com/hoodie/notify-rust/issues) or comprehensive pull requests are welcome!
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in notify-rust by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
### Conventions
The Changelog of this library is generated from its commit log, there any commit message must conform with https://www.conventionalcommits.org/en/v1.0.0/. For simplicity you could make your commits with [convco](https://crates.io/crates/convco).