Struct GraphicalEnvironment 

pub struct GraphicalEnvironment {
    pub wayland_display: Option<OsString>,
    pub x11_display: Option<OsString>,
    pub xdg_runtime_dir: Option<OsString>,
    pub activation_token: Option<String>,
}

The graphical session to connect to: the variables that locate its display server, as some process sees them.

A long-running process can outlive the graphical session it was started in, so a platform that attaches to a display server later can be given a fresher environment than its own. While connected, programs the platform launches (for example to open a URL) get these variables instead of the ones this process started with. Apply App::graphical_environment to the programs an app launches, for the same reason.

Fields

wayland_display: Option<OsString>

WAYLAND_DISPLAY: a socket name relative to xdg_runtime_dir, or an absolute path.

x11_display: Option<OsString>

DISPLAY: the X11 display name.

xdg_runtime_dir: Option<OsString>

XDG_RUNTIME_DIR: the directory containing Wayland sockets.

activation_token: Option<String>

XDG_ACTIVATION_TOKEN: lets the first window take focus on Wayland.

A platform takes this process’s token from its environment when it’s created, and uses it if it starts windowed. Pass one here to switch to windowed mode later, for example the token of the process that asked for a window.

Implementations

impl GraphicalEnvironment

pub fn detect() -> GraphicalEnvironment

Reads the display variables from this process’s environment.

This only reads environment variables: whether they name a reachable display server is checked when a platform connects. Leaves activation_token unset: see its documentation.

pub fn apply_to(&self, command: &mut Command)

Sets this environment’s display variables on command, and removes the ones it doesn’t set, so the program connects to this graphical session rather than the one this process started in. Leaves XDG_ACTIVATION_TOKEN alone.

pub fn guess_compositor(&self) -> &'static str

Returns the compositor this environment selects: Wayland, then X11, then headless.

Does not attempt to connect to the compositor.

Trait Implementations

impl Clone for GraphicalEnvironment

fn clone(&self) -> GraphicalEnvironment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphicalEnvironment

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

Formats the value using the given formatter.

impl Default for GraphicalEnvironment

fn default() -> GraphicalEnvironment

Returns the “default value” for a type.