Struct niri_ipc::socket::Socket

pub struct Socket { /* private fields */ }

Helper for blocking communication over the niri socket.

This struct is used to communicate with the niri IPC server. It handles the socket connection and serialization/deserialization of messages.

Implementations

impl Socket

pub fn connect() -> Result<Self>

Connects to the default niri IPC socket.

This is equivalent to calling Self::connect_to with the path taken from the SOCKET_PATH_ENV environment variable.

pub fn connect_to(path: impl AsRef<Path>) -> Result<Self>

Connects to the niri IPC socket at the given path.

pub fn send( self, request: Request, ) -> Result<(Reply, impl FnMut() -> Result<Event>)>

Sends a request to niri and returns the response.

Return values:

• Ok(Ok(response)): successful Response from niri
• Ok(Err(message)): error message from niri
• Err(error): error communicating with niri

This method also returns a blocking function that you can call to keep reading Events after requesting an EventStream. This function is not useful otherwise.