Crate niri_ipc

Expand description

Types for communicating with niri via IPC.

After connecting to the niri socket, you can send a single Request and receive a single Reply, which is a Result wrapping a Response. If you requested an event stream, you can keep reading Events from the socket after the response.

You can use the socket::Socket helper if you’re fine with blocking communication. However, it is a fairly simple helper, so if you need async, or if you’re using a different language, you are encouraged to communicate with the socket manually.

Read the socket filesystem path from socket::SOCKET_PATH_ENV ($NIRI_SOCKET).
Connect to the socket and write a JSON-formatted Request on a single line. You can follow up with a line break and a flush, or just flush and shutdown the write end of the socket.
Niri will respond with a single line JSON-formatted Reply.
If you requested an event stream, niri will keep responding with JSON-formatted Events, on a single line each.

§Backwards compatibility

This crate follows the niri version. It is not API-stable in terms of the Rust semver. In particular, expect new struct fields and enum variants to be added in patch version bumps.

Use an exact version requirement to avoid breaking changes:

[dependencies]
niri-ipc = "=25.2.0"

§Features

This crate defines the following features:

json-schema: derives the schemars JsonSchema trait for the types.
clap: derives the clap CLI parsing traits for some types. Used internally by niri itself.

Modules§

socket: Helper for blocking communication over the niri socket.
state: Helpers for keeping track of the event stream state.

Structs§

ConfiguredMode: Output mode as set in the config file.
ConfiguredPosition: Output position as set in the config file.
KeyboardLayouts: Configured keyboard layouts.
LayerSurface: A layer-shell surface.
LogicalOutput: Logical output in the compositor’s coordinate space.
Mode: Output mode.
Output: Connected output.
VrrToSet: Output VRR to set.
Window: Toplevel window.
Workspace: A workspace.

Enums§

Action: Actions that niri can perform.
ColumnDisplay: How windows display in a column.
Event: A compositor event.
Layer: A layer-shell layer.
LayerSurfaceKeyboardInteractivity: Keyboard interactivity modes for a layer-shell surface.
LayoutSwitchTarget: Layout to switch to.
ModeToSet: Output mode to set.
OutputAction: Output actions that niri can perform.
OutputConfigChanged: Output configuration change result.
PositionChange: Change in floating window position.
PositionToSet: Output position to set.
Request: Request from client to niri.
Response: Successful response from niri to client.
ScaleToSet: Output scale to set.
SizeChange: Change in window or column size.
Transform: Output transform, which goes counter-clockwise.
WorkspaceReferenceArg: Workspace reference (id, index or name) to operate on.

Type Aliases§

Reply: Reply from niri to client.