Struct async_i3ipc::I3

pub struct I3 { /* fields omitted */ }

Newtype wrapper for UnixStream that implements i3's IPC

Implementations

impl I3

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

Connects to I3 over UnixStream

pub async fn send_msg_body<P>(&mut self, msg: Msg, payload: P) -> Result<()> where
    P: AsRef<str>, 

pub async fn send_msg(&mut self, msg: Msg) -> Result<()>

pub async fn read_msg<D>(&mut self) -> Result<MsgResponse<D>> where
    D: DeserializeOwned, 

Receive some message from the socket. Holds a Msg type and payload

pub async fn read_event(&mut self) -> Result<Event>

Like read_msg but for event::Event

pub async fn send_read<P, D>(
    &mut self,
    msg: Msg,
    payload: P
) -> Result<MsgResponse<D>> where
    P: AsRef<str>,
    D: DeserializeOwned, 

Send a Msg and payload and receive a response. Convenience function over send_msg and read_msg

pub async fn subscribe<E>(&mut self, events: E) -> Result<Success> where
    E: AsRef<[Subscribe]>, 

Returns a Future that will send a Subscribe message to i3 along with a list of events to listen to.

pub fn listen(self) -> EventStream

Provides a type that implements Stream so you can await events in a loop

pub async fn run_command<S: AsRef<str>>(
    &mut self,
    payload: S
) -> Result<Vec<Success>>

Run an arbitrary command on i3. Response is a Vec of success true/false.

pub async fn get_workspaces(&mut self) -> Result<Workspaces>

Future for getting the current Workspaces, sends Workspaces

pub async fn get_outputs(&mut self) -> Result<Outputs>

Future that gets all Outputs, sends Outputs

pub async fn get_tree(&mut self) -> Result<Node>

Future to get complete Node, sends Tree

pub async fn get_marks(&mut self) -> Result<Marks>

Get all Marks, sends Marks

pub async fn get_bar_ids(&mut self) -> Result<BarIds>

Future to get all BarIds, sends BarConfig

pub async fn get_bar_config<S: AsRef<str>>(
    &mut self,
    bar_id: S
) -> Result<BarConfig>

Future to get configs associated with a bar id responds with BarConfig, sends BarConfig

pub async fn get_version(&mut self) -> Result<Version>

Get i3 version

pub async fn get_binding_modes(&mut self) -> Result<BindingModes>

Future to get BindingModes, sends BindingModes

pub async fn get_config(&mut self) -> Result<Config>

Future for Config, sends Config

pub async fn get_tick(&mut self) -> Result<Success>

Future sends Tick

pub async fn get_sync(&mut self) -> Result<Success>

Future Sync

Trait Implementations

impl Debug for I3

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

Formats the value using the given formatter.