Struct i3_ipc::I3Stream

pub struct I3Stream(_);

I3Stream will hold the underlying UnixStream that communicates with i3

Implementations

impl I3Stream

pub fn conn_sub<E>(events: E) -> Result<Self>where
    E: AsRef<[Subscribe]>,

Connect & subscribe in one method

Examples found in repository

examples/sync_listen.rs (line 9)

fn main() -> io::Result<()> {
    let mut i3 = I3Stream::conn_sub(&[Subscribe::Window, Subscribe::Workspace])?;
    for e in i3.listen() {
        match e? {
            Event::Workspace(ev) => println!("workspace change event {:?}", ev),
            Event::Window(ev) => println!("window event {:?}", ev),
            Event::Output(ev) => println!("output event {:?}", ev),
            Event::Mode(ev) => println!("mode event {:?}", ev),
            Event::BarConfig(ev) => println!("bar config update {:?}", ev),
            Event::Binding(ev) => println!("binding event {:?}", ev),
            Event::Shutdown(ev) => println!("shutdown event {:?}", ev),
            Event::Tick(ev) => println!("tick event {:?}", ev),
        }
    }
    Ok(())
}

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

sends a subscribe message to i3 with a json encoded array of types of events to listen to

pub fn listen(&mut self) -> I3Iter<'_>

Returns a type that implements Iterator, allowing us to listen to events

Examples found in repository

examples/sync_listen.rs (line 10)

fn main() -> io::Result<()> {
    let mut i3 = I3Stream::conn_sub(&[Subscribe::Window, Subscribe::Workspace])?;
    for e in i3.listen() {
        match e? {
            Event::Workspace(ev) => println!("workspace change event {:?}", ev),
            Event::Window(ev) => println!("window event {:?}", ev),
            Event::Output(ev) => println!("output event {:?}", ev),
            Event::Mode(ev) => println!("mode event {:?}", ev),
            Event::BarConfig(ev) => println!("bar config update {:?}", ev),
            Event::Binding(ev) => println!("binding event {:?}", ev),
            Event::Shutdown(ev) => println!("shutdown event {:?}", ev),
            Event::Tick(ev) => println!("tick event {:?}", ev),
        }
    }
    Ok(())
}

pub fn iter(&mut self) -> I3Iter<'_>

same as listen

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

Send a message and payload, used for get_* commands and run_command

pub fn receive_msg<D: DeserializeOwned>(&mut self) -> Result<MsgResponse<D>>

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

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

Like receive_msg but for event::Event

pub fn send_receive<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 receive_msg

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

Run an arbitrary command on i3.

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

Get active workspaces

Examples found in repository

examples/sync_get.rs (line 7)

fn main() -> io::Result<()> {
    let mut i3 = I3::connect()?;
    let workspaces = i3.get_workspaces()?;
    println!("{:?}", workspaces);
    Ok(())
}

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

Get active workspaces

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

Get tree of all Nodes in i3

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

Get marks

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

Get your active bar ids

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

Get bar config by id (get_bar_ids)

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

Get i3 version and config location

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

Get i3 binding modes

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

Get i3 config

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

Convenience over msg::Msg::Tick and response

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

Convenience over msg::Msg::Sync and response

pub fn get_binding_state(&mut self) -> Result<BindingState>

Get i3 binding state

Trait Implementations

impl Debug for I3Stream

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

Formats the value using the given formatter.

impl I3IPC for I3Stream

fn decode_msg(&mut self) -> Result<(u32, Vec<u8, Global>), Error>

impl I3Protocol for I3Stream

const MAGIC: &'static str = MAGIC

fn _encode_msg<P>(&self, msg: Msg, payload: Option<P>) -> Vec<u8, Global>where
    P: AsRef<str>,

fn encode_msg(&self, msg: Msg) -> Vec<u8, Global>

fn encode_msg_body<P>(&self, msg: Msg, payload: P) -> Vec<u8, Global>where
    P: AsRef<str>,

fn encode_msg_json<P>(
    &self,
    msg: Msg,
    payload: P
) -> Result<Vec<u8, Global>, Error>where
    P: Serialize,

fn decode_event(evt_type: u32, payload: Vec<u8, Global>) -> Result<Event, Error>

impl Read for I3Stream

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>where
    Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>where
    R: Read,
    Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>where
    Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl Write for I3Stream

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

Creates a “by reference” adapter for this instance of Write.