Struct Notification 

pub struct Notification<'a> {
    pub app_id: &'a str,
    pub title: &'a str,
    pub message: &'a str,
    pub icon: MessageIcon,
    pub timeout: i32,
}

Notification.

Shows a brief message to the user without blocking their interaction with the application.

// Define a unique application identifier for the notification system.
const APP_ID: &str = "com.example.myapp";

// Invoke setup at application initialization to ensure the application
// is registered and ready to show notifications later.
rustydialogs::Notification::setup(APP_ID);

rustydialogs::Notification {
	app_id: APP_ID,
	title: "Task Complete",
	message: "All files were processed successfully.",
	icon: rustydialogs::MessageIcon::Info,
	timeout: rustydialogs::Notification::SHORT_TIMEOUT,
}.show();

Fields

app_id: &'a str

Application identifier used by notification backends.

This is a best-effort hint: some backends may ignore it, and some only honor the first value seen by the process/session.

title: &'a str

The title of the notification.

message: &'a str

The message to display in the notification.

icon: MessageIcon

The icon to show in the notification.

timeout: i32

Timeout in milliseconds after which the notification should automatically close.

A value less than or equal to 0 means that the notification will not automatically close.

This is a best-effort hint: some backends may ignore it and use their own default timeout, or may not support timeouts at all.

Implementations

impl<'a> Notification<'a>

pub const SHORT_TIMEOUT: i32 = 5000

Short timeout duration in milliseconds for notification popups.

pub const LONG_TIMEOUT: i32 = 10000

Long timeout duration in milliseconds for notification popups.

pub fn setup(app_id: &str)

Perform any necessary setup for notifications, such as registering the application with the notification system.

This step is optional, when skipped the library will attempt to perform any necessary setup automatically when showing the first notification, but this method can be used to ensure that the setup is done at a specific time in the application lifecycle.

Windows

By default, this initializes a process-wide tray icon used for balloon notifications.

When using the winrt-toast backend, this creates a Start Menu shortcut for the application with the provided application identifier, which is required for showing toast notifications on Windows. It is recommended to call this method during application initialization before showing any notifications or the first notification may be skipped due to delays in the shortcut creation process.

Linux

When using the libnotify backend, this registers the application with the notification system using the provided application identifier.

Examples found in repository

examples/notification.rs (line 6)

fn main() {
	// winrt-toast: Takes almost three seconds to show the first notification due to registration delays.
	// All Notifications shown before the registration is complete will be ignored.
	rustydialogs::Notification::setup(APP_ID);

	let i = std::process::id() / 4;

	let icon = match i % 4 {
		0 => rustydialogs::MessageIcon::Info,
		1 => rustydialogs::MessageIcon::Warning,
		2 => rustydialogs::MessageIcon::Error,
		_ => rustydialogs::MessageIcon::Question,
	};

	let notify = rustydialogs::Notification {
		app_id: APP_ID,
		title: "Rusty Dialogs",
		message: "This is a native notification.",
		icon,
		timeout: rustydialogs::Notification::SHORT_TIMEOUT,
	};

	notify.show();
	println!("Notification shown");

	// winrt-toast: Wait a bit to ensure the notification is visible before the program exits.
	std::thread::sleep(std::time::Duration::from_millis(100));
}

pub fn show(&self)

Show the notification.

Examples found in repository

examples/tests.rs (line 369)

	fn notify(p: &rustydialogs::Notification<'_>) {
		println!("\n{} Confirm {} appeared.", Color("Step:", "255;214;102"), Color(format_args!("{:?}", p.icon), "255;214;102"));
		loop {
			p.show();
			if confirm("Confirm notification? [Y/n]: ", true) {
				println!("  Result: {}", Color("PASS", "123;201;111"));
				break;
			}
			println!("  Result: {}", Color("FAIL", "255;107;107"));
			if !confirm("  Test failed, retry? [Y/n]: ", true) {
				break;
			}
		}
	}

examples/notification.rs (line 25)

fn main() {
	// winrt-toast: Takes almost three seconds to show the first notification due to registration delays.
	// All Notifications shown before the registration is complete will be ignored.
	rustydialogs::Notification::setup(APP_ID);

	let i = std::process::id() / 4;

	let icon = match i % 4 {
		0 => rustydialogs::MessageIcon::Info,
		1 => rustydialogs::MessageIcon::Warning,
		2 => rustydialogs::MessageIcon::Error,
		_ => rustydialogs::MessageIcon::Question,
	};

	let notify = rustydialogs::Notification {
		app_id: APP_ID,
		title: "Rusty Dialogs",
		message: "This is a native notification.",
		icon,
		timeout: rustydialogs::Notification::SHORT_TIMEOUT,
	};

	notify.show();
	println!("Notification shown");

	// winrt-toast: Wait a bit to ensure the notification is visible before the program exits.
	std::thread::sleep(std::time::Duration::from_millis(100));
}

Trait Implementations

impl<'a> Clone for Notification<'a>

fn clone(&self) -> Notification<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Notification<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Copy for Notification<'a>