Skip to main content

Niri

Struct Niri 

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

The niri service, from cx.niri(). A clone is cheap and shares the one connection.

Implementations§

Source§

impl Niri

Source

pub fn workspaces(&self) -> ReadSignal<Vec<NiriWorkspace>>

Every workspace, by output name and then by idx. Empty while niri isn’t connected.

Source

pub fn windows(&self) -> ReadSignal<Vec<NiriWindow>>

Every window, by id. Empty while niri isn’t connected.

Source

pub fn keyboard_layouts(&self) -> ReadSignal<Option<NiriKeyboardLayouts>>

The keyboard layouts, once niri has said them.

Source

pub fn overview_open(&self) -> ReadSignal<bool>

Whether niri’s overview is open.

Source

pub fn focus_workspace(&self, id: u64)

Switches to the workspace with the id id.

Source

pub fn focus_window(&self, id: u64)

Focuses the window with the id id.

Source

pub fn action(&self, action: Value)

Sends niri {"Action": action}, as niri msg action does, on a connection of its own, and never waits for it. action is one of niri-ipc’s Actions in JSON, such as json!({ "Spawn": { "command": ["foot"] } }). niri’s refusal is logged, and so is an action over 8 KiB, or past 64 waiting for a reply, which isn’t sent.

Source

pub fn on_event(&self, handler: impl Fn(&Value) + 'static)

Calls handler with every event niri sends, as its JSON, such as {"OverviewOpenedOrClosed":{"is_open":true}}, until the context cx.niri() was called on goes. The lists have taken the event in by then.

It runs on the main thread. If it panics, that is logged with the event’s name and where on_event was called, and it isn’t called again. Called on a handle whose context went, it logs that and does nothing.

Trait Implementations§

Source§

impl Clone for Niri

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Niri

§

impl !Send for Niri

§

impl !Sync for Niri

§

impl !UnwindSafe for Niri

§

impl Forget for Niri

§

impl Freeze for Niri

§

impl Move for Niri

§

impl Unpin for Niri

§

impl UnsafeUnpin for Niri

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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