Rust API

window.Window.get

Rust

Python Unavailable
TypeScript Unavailable
Rust
Go Unavailable
Java Unavailable
.NET Unavailable
C++ Unavailable
Swift Unavailable

Module: window
Declared in: Window
Package: libtmux
Source: crates/libtmux/src/window.rs

get ( self , field : F ) → Availability<F::Value<'_>> method [source] ¶ method [source] ¶ get

Read one field of this window's snapshot, named by the handle that filters it.

Every field in WindowFields reads this way, including those with no getter of their own. Nothing is sent to tmux, so the value is as old as the snapshot. The result says why a field holds no value: see Availability .

Examples

use libtmux::query::Filterable as _;
use libtmux::{Availability, Window};

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("read").await?;
let window = session.active_window().await?.expect("a session has a window");
let fields = Window::filter_fields();

// The layout as shown, which only differs from the layout while zoomed.
assert_eq!(
    window.get(fields.window_visible_layout),
    Availability::Available(window.layout()),
);
assert_eq!(window.get(fields.window_id), Availability::Available(window.id()));

guard.shutdown().await?;

0 declared, 0 inherited