Struct Socket 

pub struct Socket<S> { /* private fields */ }

Implementations

impl<S: SocketStream> Socket<S>

pub async fn connect() -> Result<Self, Error>

Connects to the default niri IPC socket.

This is the async version of Socket::connect

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

Connects to the niri IPC socket at the given path.

This is the async version of Socket::connect_to

pub async fn send(&mut self, request: Request) -> Result<Reply, Error>

Sends a request to niri and returns the response.

This is the async version of Socket::send

pub async fn into_event_stream( self, ) -> Result<impl Stream<Item = Result<Event, Error>>, IntoEventStreamError>

Send request and reading event stream Events from the socket.

Note that unlike the Socket::read_events, this method will send an EventStream request.

Examples

use niri_ipc::{Request, Response};
use niri_ipc::socket::Socket;

async fn print_events() -> Result<(), std::io::Error> {
    let mut socket = Socket::connect().await?;

    let reply = socket.into_event_stream().await;
    if let Ok(event_stream) = reply {
        let read_event = std::pin::pin!(event_stream);
        while let Some(event) = read_event.next().await {
            println!("Received event: {event:?}");
        }
    }

    Ok(())
}