Struct i3ipc::I3Connection

pub struct I3Connection { /* fields omitted */ }

Abstraction over an ipc socket to i3. Handles messages/replies.

Methods

impl I3Connection

pub fn connect() -> Result<I3Connection, EstablishError>

Establishes the IPC connection.

pub fn command(&mut self, string: &str) -> Result<Command, MessageError>

Deprecated since 0.8.0:

Renamed to run_command

pub fn run_command(&mut self, string: &str) -> Result<Command, MessageError>

The payload of the message is a command for i3 (like the commands you can bind to keys in the configuration file) and will be executed directly after receiving it.

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

Gets the current workspaces.

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

Gets the current outputs.

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

Gets the layout tree. i3 uses a tree as data structure which includes every container.

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

Gets a list of marks (identifiers for containers to easily jump to them later).

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

Gets an array with all configured bar IDs.

pub fn get_bar_config(&mut self, id: &str) -> Result<BarConfig, MessageError>

Gets the configuration of the workspace bar with the given ID.

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

Gets the version of i3. The reply will include the major, minor, patch and human-readable version.

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

This is supported on feature="i3-4-13" only.

Gets the list of currently configured binding modes.

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

This is supported on feature="i3-4-14" only.

Returns the last loaded i3 config.

Trait Implementations

impl Debug for I3Connection

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

Formats the value using the given formatter.