Rust API

session.Session.get

Rust

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

Module: session
Declared in: Session
Package: libtmux
Source: crates/libtmux/src/session.rs

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

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

Every field in SessionFields 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, Session};

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("read").await?;
let fields = Session::filter_fields();

// Nobody is attached, so nobody is attached twice.
assert_eq!(session.get(fields.session_many_attached), Availability::Available(false));
assert_eq!(session.get(fields.session_id), Availability::Available(session.id()));

guard.shutdown().await?;

0 declared, 0 inherited