Enum notify_rust::Hint

pub enum Hint {
    ActionIcons(bool),
    Category(String),
    DesktopEntry(String),
    ImagePath(String),
    Resident(bool),
    SoundFile(String),
    SoundName(String),
    SuppressSound(bool),
    Transient(bool),
    X(i32),
    Y(i32),
    Urgency(Urgency),
    Custom(String, String),
    CustomInt(String, i32),
    Invalid,
}

Hints allow you to pass extra information to the server.

Many of these are standardized by either:

• http://www.galago-project.org/specs/notification/0.9/x344.html
• https://developer.gnome.org/notification-spec/#hints

Which of these are actually implemented depends strongly on the Notification server you talk to. Usually the get_capabilities() gives some clues, but the standards usually mention much more than is actually available.

you pass these to Notification::hint

Variants

ActionIcons(bool)

If true, server may interpret action identifiers as named icons and display those.

Tuple Fields of ActionIcons

0: bool

Category(String)

Check out:

• http://www.galago-project.org/specs/notification/0.9/x211.html
• https://developer.gnome.org/notification-spec/#categories

Tuple Fields of Category

0: String

DesktopEntry(String)

Name of the DesktopEntry representing the calling application. In case of “firefox.desktop” use “firefox”. May be used to retrieve the correct icon.

Tuple Fields of DesktopEntry

0: String

ImagePath(String)

Display the image at this path.

Tuple Fields of ImagePath

0: String

Resident(bool)

This does not work on all servers, however timeout=0 will do the job

Tuple Fields of Resident

0: bool

SoundFile(String)

Play the sound at this path.

Tuple Fields of SoundFile

0: String

SoundName(String)

A themeable named sound from the freedesktop.org sound naming specification to play when the notification pops up. Similar to icon-name, only for sounds. An example would be “message-new-instant”.

Tuple Fields of SoundName

0: String

SuppressSound(bool)

Suppress the notification sound.

Tuple Fields of SuppressSound

0: bool

Transient(bool)

When set the server will treat the notification as transient and by-pass the server’s persistence capability, if it should exist.

Tuple Fields of Transient

0: bool

X(i32)

Lets the notification point to a certain ‘x’ position on the screen. Requires Y.

Tuple Fields of X

0: i32

Y(i32)

Lets the notification point to a certain ‘y’ position on the screen. Requires X.

Tuple Fields of Y

0: i32

Urgency(Urgency)

Pass me a Urgency, either Low, Normal or Critical

Tuple Fields of Urgency

0: Urgency

Custom(String, String)

If you want to pass something entirely different.

Tuple Fields of Custom

0: String1: String

CustomInt(String, i32)

A custom numerical (integer) hint

Tuple Fields of CustomInt

0: String1: i32

Invalid

Only used by this NotificationServer implementation

Implementations

impl Hint

pub fn as_bool(&self) -> Option<bool>

Get the bool representation of this hint.

pub fn as_i32(&self) -> Option<i32>

Get the i32 representation of this hint.

pub fn as_str(&self) -> Option<&str>

Get the &str representation of this hint.

pub fn from_key_val(name: &str, value: &str) -> Result<Hint, String>

convenience converting a name and value into a hint

Trait Implementations

impl Clone for Hint

fn clone(&self) -> Hint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hint

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

Formats the value using the given formatter.

impl<'a> From<&'a Hint> for (&'a str, Value<'a>)

fn from(val: &'a Hint) -> Self

Performs the conversion.

impl Hash for Hint

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Hint> for Hint

fn eq(&self, other: &Hint) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Hint) -> bool

This method tests for !=.

impl Eq for Hint

impl StructuralEq for Hint

impl StructuralPartialEq for Hint