Struct Hyprland 

pub struct Hyprland { /* private fields */ }

Connection details for a running Hyprland instance.

Implementations

impl Hyprland

pub fn connect() -> Option<Self>

Locate the running instance’s sockets from the environment. Returns None when not under Hyprland, or when the sockets are not present.

pub fn active_workspace(&self) -> Option<String>

The name of the workspace currently on the focused monitor.

pub fn workspace_names(&self) -> Vec<String>

Existing workspace names, ordered by numeric id (so “previous”/“next” follow the compositor’s ordering, not creation order).

pub fn dispatch_workspace(&self, name: &str)

Ask the compositor to switch to name.

The portable form is dispatch workspace <name>, but a Lua-configured Hyprland (Omarchy) routes dispatch through hl.dispatch and rejects it; there the hl.dsp.focus dispatcher is required. Try the portable form first and fall back when the compositor reports an error.

pub fn spawn_watcher(&self, on_change: impl Fn(String) + Send + 'static)

Spawn a thread that calls on_change with the newly focused workspace’s name whenever it changes. The thread exits when the socket closes (e.g. the compositor restarts).

Trait Implementations

impl Clone for Hyprland

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Hyprland

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

Formats the value using the given formatter.