Expand description
A crate that provides a rust interface to communicate with the Hyprland sockets.
There are two types of Hyprland sockets, one used for events and one used for commands or to request data (ie. clients, decorations, etc.)
The main struct of this crate is HyprlandConnection. It’s used for connecting to both
sockets (except when you need sync events, in which case you should use DetachedEventConnection).
§Crate overview
§Get started
By default, this crate enables both the sync and async features. It’s preferred to disable
default features and include only the sync feature if you don’t need async, this way
tokio is not included.
To get started add this crate to your project:
cargo add hyprrust§Module structure
This crate conatins several modules:
commandsAll implemented commands, but doesn’t include arguments.commands::preludeAll commands and arguments.dataAll commands used to request data from Hyprland.errorsAll errors returned by the API of this library.eventsContains everything needed to receive sync and async events and filter them.
§Examples
See the examples folder in the crates source.
Modules§
Macros§
- make_
command - Used to easily create commands.
Structs§
- Hyprland
Connection - Represents a connection to Hyprland, it can be used to start an event listener or to send commands to Hyprland