Enum niri_ipc::Request

pub enum Request {
    Version,
    Outputs,
    Workspaces,
    Windows,
    Layers,
    KeyboardLayouts,
    FocusedOutput,
    FocusedWindow,
    Action(Action),
    Output {
        output: String,
        action: OutputAction,
    },
    EventStream,
    ReturnError,
}

Request from client to niri.

Variants

Version

Request the version string for the running niri instance.

Outputs

Request information about connected outputs.

Workspaces

Request information about workspaces.

Windows

Request information about open windows.

Layers

Request information about layer-shell surfaces.

KeyboardLayouts

Request information about the configured keyboard layouts.

FocusedOutput

Request information about the focused output.

FocusedWindow

Request information about the focused window.

Action(Action)

Perform an action.

Output

Change output configuration temporarily.

The configuration is changed temporarily and not saved into the config file. If the output configuration subsequently changes in the config file, these temporary changes will be forgotten.

Fields

output: String

Output name.

action: OutputAction

Configuration to apply.

EventStream

Start continuously receiving events from the compositor.

The compositor should reply with Reply::Ok(Response::Handled), then continuously send Events, one per line.

The event stream will always give you the full current state up-front. For example, the first workspace-related event you will receive will be Event::WorkspacesChanged containing the full current workspaces state. You do not need to separately send Request::Workspaces when using the event stream.

Where reasonable, event stream state updates are atomic, though this is not always the case. For example, a window may end up with a workspace id for a workspace that had already been removed. This can happen if the corresponding Event::WorkspacesChanged arrives before the corresponding Event::WindowOpenedOrChanged.

ReturnError

Respond with an error (for testing error handling).

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Request

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Request

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

where __S: Serializer,

Serialize this value into the given Serde serializer.