Struct TagHandle

pub struct TagHandle { /* private fields */ }

A handle to a tag.

This handle allows you to do things like switch to tags and get their properties.

Implementations

impl TagHandle

pub fn from_id(id: u32) -> Self

Creates a tag handle from a numeric id.

pub fn switch_to(&self)

Activates this tag and deactivates all other ones on the same output.

This emulates what a traditional workspace is.

Examples

// Assume the focused output has the following inactive tags and windows:
// "1": Alacritty
// "2": Firefox, Discord
// "3": Steam
tag::get("2")?.switch_to(); // Displays Firefox and Discord
tag::get("3")?.switch_to(); // Displays Steam

pub fn set_active(&self, set: bool)

Sets this tag to active or not.

While active, windows with this tag will be displayed.

While inactive, windows with this tag will not be displayed unless they have other active tags.

Examples

// Assume the focused output has the following inactive tags and windows:
// "1": Alacritty
// "2": Firefox, Discord
// "3": Steam
tag::get("2")?.set_active(true);  // Displays Firefox and Discord
tag::get("3")?.set_active(true);  // Displays Firefox, Discord, and Steam
tag::get("2")?.set_active(false); // Displays Steam

pub fn toggle_active(&self)

Toggles this tag between active and inactive.

While active, windows with this tag will be displayed.

While inactive, windows with this tag will not be displayed unless they have other active tags.

Examples

// Assume the focused output has the following inactive tags and windows:
// "1": Alacritty
// "2": Firefox, Discord
// "3": Steam
tag::get("2")?.toggle_active(); // Displays Firefox and Discord
tag::get("3")?.toggle_active(); // Displays Firefox, Discord, and Steam
tag::get("3")?.toggle_active(); // Displays Firefox, Discord
tag::get("2")?.toggle_active(); // Displays nothing

pub fn remove(&self)

Removes this tag from its output.

Examples

let tags =
    tag::add(&output::get_by_name("DP-1")?, ["1", "2", "Buckle", "Shoe"]).collect::<Vec<_>>();

tags[1].remove();
tags[3].remove();
// "DP-1" now only has tags "1" and "Buckle"

pub fn active(&self) -> bool

Gets whether or not this tag is active.

pub async fn active_async(&self) -> bool

Async impl for Self::active.

pub fn name(&self) -> String

Gets this tag’s name.

pub async fn name_async(&self) -> String

Async impl for Self::name.

pub fn output(&self) -> OutputHandle

Gets a handle to the output this tag is on.

pub async fn output_async(&self) -> OutputHandle

Async impl for Self::output.

pub fn windows(&self) -> impl Iterator<Item = WindowHandle>

Gets all windows with this tag.

pub async fn windows_async(&self) -> impl Iterator<Item = WindowHandle>

Async impl for Self::windows.

pub fn id(&self) -> u32

Gets this tag’s raw compositor id.

Trait Implementations

impl Clone for TagHandle

fn clone(&self) -> TagHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TagHandle

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

Formats the value using the given formatter.

impl Hash for TagHandle

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 PartialEq for TagHandle

fn eq(&self, other: &TagHandle) -> 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 Eq for TagHandle

impl StructuralPartialEq for TagHandle