Struct niri_ipc::Workspace

pub struct Workspace {
    pub id: u64,
    pub idx: u8,
    pub name: Option<String>,
    pub output: Option<String>,
    pub is_active: bool,
    pub is_focused: bool,
    pub active_window_id: Option<u64>,
}

A workspace.

Fields

id: u64

Unique id of this workspace.

This id remains constant regardless of the workspace moving around and across monitors.

Do not assume that workspace ids will always increase without wrapping, or start at 1. That is an implementation detail subject to change. For example, ids may change to be randomly generated for each new workspace.

idx: u8

Index of the workspace on its monitor.

This is the same index you can use for requests like niri msg action focus-workspace.

This index will change as you move and re-order workspace. It is merely the workspace’s current position on its monitor. Workspaces on different monitors can have the same index.

If you need a unique workspace id that doesn’t change, see Self::id.

name: Option<String>

Optional name of the workspace.

output: Option<String>

Name of the output that the workspace is on.

Can be None if no outputs are currently connected.

is_active: bool

Whether the workspace is currently active on its output.

Every output has one active workspace, the one that is currently visible on that output.

is_focused: bool

Whether the workspace is currently focused.

There’s only one focused workspace across all outputs.

active_window_id: Option<u64>

Id of the active window on this workspace, if any.

Trait Implementations

impl Clone for Workspace

fn clone(&self) -> Workspace

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Workspace

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Workspace

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Workspace

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Workspace

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Workspace

impl StructuralPartialEq for Workspace