hyprshell

The hyprland crate is an unofficial Rust wrapper for Hyprland's IPC. It is organized into several modules that allow you to interact with the compositor:

• data: Retrieve information about the compositor state.
• event_listener: Provides the EventListener struct to listen for real-time compositor events.
• dispatch: Call Hyprland dispatchers.
• keyword: Manage configuration options (keywords).
• config::binds: Modify keybindings (future updates may include full config generation).
• ctl: Execute hyprctl commands.
• Shared module: Provides common types used across the crate.

The hyprshell-config-lib crate is responsible for managing Hyprshell configuration. Its primary responsibilities include:

• Parsing: Converting on-disk configuration files into the internal data structures used by the application at runtime.
• Writing: Saving configuration changes back to disk.
• Migration: Managing versioned migration paths to ensure that user configurations remain functional as the configuration schema evolves over time.

The hyprshell-exec-lib crate provides low-level command execution helpers used across the Hyprshell ecosystem. Its primary responsibility is implementing Hyprland-specific logic for loading system data, such as windows and workspaces.

This crate serves as an abstraction layer for window manager interaction. To port Hyprshell to a different window manager, a developer would theoretically only need to reimplement the public functions provided by this crate.

The hyprshell-launcher-lib crate is the core engine for the hyprshell launcher. It is responsible for managing the lifecycle of search results and user interactions.

Key responsibilities include:

• Result Management: Building both static and dynamic result sets.
• Scoring & Selection: Scoring user input against available items and determining which item is the primary candidate for display or execution.
• Action Handling: Managing how actions are triggered once an item is selected.
• Integrations: Providing built-in support for calculators and path resolution.
• Matching Logic: Implementing custom matching algorithms, including support for actions that require arguments.

Beyond the core library, the Relm4 ecosystem includes several specialized crates and tools:

• relm4-macros: Macros for declarative UI definitions.
• relm4-components: A collection of reusable UI components.
• relm4-icons: A set of icons for applications.
• relm4-template: A starter template for creating Relm4 applications in the Flatpak package format.
• relm4-snippets: VS Code snippets to accelerate development.

To use the hyprland crate in your project, add it to your Cargo.toml dependencies. You can use the stable beta version or the master branch from GitHub if you need the latest unreleased features or fixes.

Stable Beta Version:

hyprland = "0.4.0-beta.3"

Master Branch (Git): Note: Using the git dependency will prevent your crate from being published to crates.io.

hyprland = { git = "https://github.com/hyprland-community/hyprland-rs", branch = "master" }