Enum detect_desktop_environment::DesktopEnvironment

#[non_exhaustive]
pub enum DesktopEnvironment {
    Cinnamon,
    Cosmic,
    Dde,
    Ede,
    Endless,
    Enlightenment,
    Gnome,
    Hyprland,
    Kde,
    Lxde,
    Lxqt,
    MacOs,
    Mate,
    Old,
    Pantheon,
    Razor,
    Rox,
    Sway,
    Tde,
    Unity,
    Windows,
    Xfce,
}

Desktop environments supported by detect-desktop-environment.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Cinnamon

Cinnamon, the default desktop environment for Linux Mint.

• https://en.wikipedia.org/wiki/Cinnamon_(desktop_environment)

Cosmic

COSMIC, the default desktop environment for Linux Pop!_OS.

Note: This corresponds to the classic COSMIC based on GNOME, not the Rust COSMIC-epoch. Please send a PR if you can test how to detect cosmic-epoch.

• https://github.com/pop-os/cosmic

Dde

Deepin desktop environment

• https://www.deepin.org/index/en

Ede

EDE Desktop

• https://edeproject.org/

Endless

Endless OS desktop

• https://www.endlessos.org/os

Enlightenment

Enlightenment desktop environment.

• https://en.wikipedia.org/wiki/Enlightenment_(software)

Gnome

Gnome, the default environment for many major Linux distributions.

• https://en.wikipedia.org/wiki/GNOME

Hyprland

Hyprland tiling window manager

• https://hyprland.org/

Kde

KDE Plasma, the Kool Desktop Environment.

• https://kde.org/plasma-desktop/

Lxde

LXDE

• https://www.lxde.org/

Lxqt

LXQt

• https://lxqt-project.org/

MacOs

MacOs, the environment for Apple’s OS

Mate

MATE

• https://mate-desktop.org/

Old

Legacy menu systems

Listed in Freedesktop Desktop Environments.

Pantheon

Elementary OS Desktop Environment

• https://elementary.io/

Razor

Razor-qt

Discontinued Desktop Environment, this is an ancestor of LXQt.

• https://github.com/Razor-qt/razor-qt

Rox

ROX Desktop

• https://rox.sourceforge.net/desktop/

Sway

Sway tiling window manager

• https://swaywm.org/

Tde

TrinityDesktopEnvironment

• https://www.trinitydesktop.org/

Unity

Unity, the legacy desktop environment for Ubuntu

• https://en.wikipedia.org/wiki/Unity_%28user_interface%29

Windows

Windows, the environments for Microsoft’s OS

Xfce

Xfce

• https://xfce.org/

Implementations

impl DesktopEnvironment

pub fn detect() -> Option<Self>

Detect the current desktop environment

If the current desktop environment can’t be detected, None is returned.

pub const fn gtk(self) -> bool

Test if the desktop environment is based on the GTK framework

See https://en.wikipedia.org/wiki/Category:Desktop_environments_based_on_GTK

use detect_desktop_environment::DesktopEnvironment;

// All matching desktop environments:
assert!(DesktopEnvironment::Cinnamon.gtk());
assert!(DesktopEnvironment::Cosmic.gtk());
assert!(DesktopEnvironment::Gnome.gtk());
assert!(DesktopEnvironment::Lxde.gtk());
assert!(DesktopEnvironment::Mate.gtk());
assert!(DesktopEnvironment::Unity.gtk());
assert!(DesktopEnvironment::Xfce.gtk());
assert!(DesktopEnvironment::Pantheon.gtk());
assert!(DesktopEnvironment::Dde.gtk());

// Non-GTK examples
assert!(!DesktopEnvironment::Kde.gtk());
assert!(!DesktopEnvironment::Windows.gtk());

pub const fn qt(self) -> bool

Test if the desktop environment is based on the Qt framework

use detect_desktop_environment::DesktopEnvironment;

// All matching desktop environments:
assert!(DesktopEnvironment::Kde.qt());
assert!(DesktopEnvironment::Lxqt.qt());
assert!(DesktopEnvironment::Razor.qt());
assert!(DesktopEnvironment::Tde.qt());

// Non-Qt examples
assert!(!DesktopEnvironment::Gnome.qt());
assert!(!DesktopEnvironment::Windows.qt());

pub fn from_freedesktop(name: &str) -> Option<Self>

Parse the desktop environment from the name registered with Freedesktop.org

See https://specifications.freedesktop.org/menu-spec/latest/apb.html

Returns None if the desktop is not registered.

This function is strictly restricted to the DEs registered with Freedesktop, for a more complete list use DesktopEnvironment::from_xdg_name. Note that the check follows the spec and is case-sensitive.

use detect_desktop_environment::DesktopEnvironment;

assert_eq!("KDE", Some(DesktopEnvironment::Kde));
assert_eq!("kde", None); // must be uppercase
assert_eq!("SWAY", None); // not registered
assert_eq!("unknown_de", None);

pub fn from_xdg_name(name: &str) -> Option<Self>

Parse the XDG desktop environment name

This is an extended variant of DesktopEnvironment::from_freedesktop. It supports all registered Freedesktop names, as well as some extra unregistered names. This is the recommended method to parse names from the list in the env var XDG_CURRENT_DESKTOP.

Returns None if the name is unknown.

use detect_desktop_environment::DesktopEnvironment;

assert_eq!("KDE", Some(DesktopEnvironment::Kde)); // freedesktop DE
assert_eq!("kde", None); // must be uppercase
assert_eq!("SWAY", Some(DesktopEnvironment::Sway)); // not registered
assert_eq!("unknown_de", None);

pub fn from_xdg_current_desktop(xdg_current_desktop: &str) -> Option<Self>

Retrieve the desktop environment from the format used by XDG_CURRENT_DESKTOP.

XDG_CURRENT_DESKTOP is a colon separated list of information about the current desktop environment. See: https://specifications.freedesktop.org/mime-apps-spec/1.0.1/ar01s02.html

Returns None if the resolution fails. Duplicate entries are allowed as long as they correspond to same Desktop Environment.

Trait Implementations

impl Clone for DesktopEnvironment

fn clone(&self) -> DesktopEnvironment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DesktopEnvironment

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

Formats the value using the given formatter.

impl Hash for DesktopEnvironment

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DesktopEnvironment

fn cmp(&self, other: &DesktopEnvironment) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for DesktopEnvironment

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for DesktopEnvironment

fn partial_cmp(&self, other: &DesktopEnvironment) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for DesktopEnvironment

impl Eq for DesktopEnvironment

impl StructuralPartialEq for DesktopEnvironment