libawm 0.1.0

the library that powers awm - forked from penrose
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

//! A simple wrapper around notify-send to allow for generating notifications
use crate::{core::helpers::spawn_with_args, ErrorHandler, PenroseError, Result};

use std::fmt;

/// A notification level when calling notify-send
///
/// The effect of this on the generated notification will depend on the notification
/// daemon that you are using.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub enum NotifyLevel {
    /// Low priority
    Low,
    /// Normal priority
    Normal,
    /// Critical / high priority
    Critical,
}

impl fmt::Display for NotifyLevel {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let s = match self {
            Self::Low => "low",
            Self::Normal => "normal",
            Self::Critical => "critical",
        };

        write!(f, "{}", s)
    }
}

/// Notification configuration
#[derive(Debug)]
pub struct NotifyConfig {
    /// The urgency level of the generated notification
    ///
    /// default: Normal
    level: NotifyLevel,
    /// Duration in milliseconds that the notification should be displayed for
    ///
    /// default: 5000
    duration: usize,
}

impl Default for NotifyConfig {
    fn default() -> Self {
        Self {
            level: NotifyLevel::Normal,
            duration: 5000,
        }
    }
}

/// Send a notification using the `notify-send` command line program
///
/// # Example
/// ```no_run
/// # use penrose::{contrib::extensions::notify_send::*};
/// # fn example() -> penrose::Result<()> {
/// notify_send("My Notification", "hello from penrose!", NotifyConfig::default())?;
///
/// // equivalent to the following on the command line:
/// // $ notify-send 'My Notification' 'hello from penrose!' -u normal -t 5000
/// # Ok(())
/// # }
/// ```
pub fn notify_send(
    title: impl Into<String>,
    body: impl Into<String>,
    config: NotifyConfig,
) -> Result<()> {
    spawn_with_args(
        "notify-send",
        &[
            "-u",
            &config.level.to_string(),
            "-t",
            &config.duration.to_string(),
            &title.into(),
            &body.into(),
        ],
    )
}

/// A simple error handler that uses 'notify-send' to display a dialog window with the error
/// message.
pub fn notify_send_error_handler() -> ErrorHandler {
    Box::new(|e: PenroseError| {
        if notify_send(
            "Unhandled Error",
            e.to_string(),
            NotifyConfig {
                level: NotifyLevel::Critical,
                duration: 10000,
            },
        )
        .is_err()
        {
            error!("Unable to display error via notify-send. Error was: {}", e);
        }
    })
}