Skip to main content

SwayIpcClient

Struct SwayIpcClient 

Source
pub struct SwayIpcClient { /* private fields */ }
Expand description

Sway IPC client for communicating with sway.

Implementations§

Source§

impl SwayIpcClient

Source

pub fn new() -> Result<Self>

Create a new sway IPC client. Uses the SWAYSOCK environment variable to find the socket.

Source

pub fn with_path<P: AsRef<Path>>(socket_path: P) -> Self

Create with a specific socket path.

Source

pub fn subscribe(&self, events: &[&str]) -> Result<EventStream>

Subscribe to sway events. Returns an EventStream that yields events. Events: “workspace”, “output”, “mode”, “window”, “barconfig_update”, “binding”, “shutdown”, “tick”

Source

pub fn run_command(&self, command: &str) -> Result<Vec<CommandResult>>

Send a command to sway and get the result.

Source

pub fn get_workspaces(&self) -> Result<Vec<SwayWorkspace>>

Get all workspaces.

Source

pub fn get_outputs(&self) -> Result<Vec<SwayOutput>>

Get all outputs.

Source

pub fn get_focused_workspace(&self) -> Result<SwayWorkspace>

Get the focused workspace.

Source

pub fn is_focused_workspace_empty(&self) -> Result<bool>

Check if the focused workspace is empty (no windows/containers).

Source

pub fn rename_workspace(&self, old_name: &str, new_name: &str) -> Result<()>

Rename a workspace.

Source

pub fn get_tree(&self) -> Result<Vec<u8>>

Get the sway tree (for introspecting containers, windows, etc.)

Source

pub fn get_workspace_names(&self) -> Result<Vec<String>>

Get current workspace names.

Source

pub fn get_primary_output(&self) -> Result<String>

Get the primary output (output of the currently focused workspace). Falls back to the first available output.

Trait Implementations§

Source§

impl Clone for SwayIpcClient

Source§

fn clone(&self) -> SwayIpcClient

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for SwayIpcClient

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more