Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-rs latest

Server.windows

List every window on the server, preserving any failure.

Source and package
Qualified name
libtmux::server::Server::windows
Module
server
Declared in
Server
Package
libtmux
Source
crates/libtmux/src/server/discovery.rs
Other languages
Perlmethod Erlangfunction PowerShellcmdlet Juliafunction Elixirfunction Haskell Common Lispfunction PythonRubyLuaTypeScriptGoJavaC#C++SwiftKotlinScalaOCamlfunction F#function Clojurefunction
pub async fn windows(&self) -> Result<Vec<Window>, Error>

Description#

Errors

Returns an error when the list command cannot run, or when its output cannot be decoded into snapshots.

Examples#

List sessions, windows and panes. Read each collection and its relations, then inspect a hierarchy snapshot. Use Rust 1.85 or newer with Cargo, and tmux 3.3a or newer, on a Unix system. In an empty directory, create a project and add the published crates:

Terminal window
$ cargo init --name libtmux-api-example &&
cargo add libtmux@0.1.2 tempfile@3.20 &&
cargo add tokio@1.40 --features macros,rt,time

Replace src/main.rs with this complete program. It owns a private tmux socket, applies a ten-second task deadline, and reports both task and cleanup errors. Server::kill() stops its daemon; Server::shutdown() closes its client executor. Successful cleanup removes the temporary directory even when the task fails. View source

//! List sessions, windows and panes, then read their hierarchy.
use std::error::Error;
use std::time::Duration;
use libtmux::{NewSessionOptions, NewWindowOptions, Server};
type ExampleError = Box<dyn Error>;
fn check(condition: bool, message: &str) -> Result<(), ExampleError> {
if condition {
Ok(())
} else {
Err(message.into())
}
}
async fn demonstrate(server: &Server) -> Result<(), ExampleError> {
let session = server
.new_session(
NewSessionOptions::new("work")
.window_name("editor")
.command("cat"),
)
.await?;
session
.new_window(NewWindowOptions::new("logs").command("cat"))
.await?;
let sessions = server.sessions().await?;
let windows = server.windows().await?;
let panes = server.panes().await?;
check(sessions.len() == 1, "expected one session")?;
check(windows.len() == 2, "expected two windows")?;
check(panes.len() == 2, "expected two panes")?;
check(
session.windows().await?.len() == 2,
"expected two session windows",
)?;
check(
session.panes().await?.len() == 2,
"expected two session panes",
)?;
for window in &windows {
check(
window.session_id() == session.id(),
"window belongs to another session",
)?;
check(
window.panes().await?.len() == 1,
"expected one pane per window",
)?;
}
let hierarchy = server.hierarchy().await?;
let branch = hierarchy.first().ok_or("hierarchy has no session")?;
check(
branch.session.id() == session.id(),
"hierarchy session differs",
)?;
check(branch.windows.len() == 2, "expected two hierarchy windows")?;
check(
branch.windows.iter().all(|window| window.panes.len() == 1),
"hierarchy panes differ",
)?;
println!("listings: 1 session, 2 windows, 2 panes");
Ok(())
}
#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), ExampleError> {
let root = std::path::Path::new("/tmp/libtmux-rs-dev");
std::fs::create_dir_all(root)?;
let directory = tempfile::Builder::new()
.prefix("api-listings-")
.tempdir_in(root)?;
std::fs::write(
directory.path().join("owner"),
std::process::id().to_string(),
)?;
let server = Server::builder()
.socket_path(directory.path().join("tmux.sock"))
.config_file("/dev/null")
.default_timeout(Duration::from_secs(5))
.build()?;
let outcome = tokio::time::timeout(Duration::from_secs(10), demonstrate(&server)).await;
// Stop the owned daemon before closing the client executor.
let killed = server.kill().await;
let closed = server.shutdown().await;
let cleanup_failed = killed.is_err() || closed.is_err();
let mut failures = Vec::new();
match outcome {
Ok(Ok(())) => {}
Ok(Err(error)) => failures.push(format!("example failed: {error}")),
Err(error) => failures.push(format!("example deadline: {error}")),
}
if let Err(error) = killed {
failures.push(format!("daemon cleanup: {error}"));
}
if let Err(error) = closed {
failures.push(format!("executor cleanup: {error}"));
}
if cleanup_failed {
let retained = directory.keep();
failures.push(format!("inspect retained directory {}", retained.display()));
} else if let Err(error) = directory.close() {
failures.push(format!("directory cleanup: {error}"));
}
if failures.is_empty() {
Ok(())
} else {
Err(failures.join("; ").into())
}
}

Run the consumer. Success exits with status 0; setup, operation, deadline or cleanup failures exit unsuccessfully and print diagnostics to stderr:

Terminal window
$ cargo run --quiet

Expected output:

listings: 1 session, 2 windows, 2 panes

In other ports#

List the server's windows

Equivalents of List the server's windows in other languages
Language Equivalent
Python libtmux.Server.windows
Ruby LibTmux::Server#list_windows
Lua libtmux.Snapshot.windows
PowerShell LibTmux\Get-TmuxWindow Use the -Server parameter set to acquire window placements across all sessions.
Julia LibTmux.windows windows with a Snapshot reads every captured physical window. Use windowlinks for session placements.
Erlang tmux_snapshot:windows/1 Returns unique captured physical windows. window_links/1 lists session memberships.
Elixir LibTmux.Snapshot.windows/1 Returns a Selection of every captured physical window. window_links/1 lists session placements.
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Common Lisp libtmux:windows windows on a snapshot returns captured physical windows once each.
TypeScript server.Server.windows
Go tmux.Server.Windows
Java io.github.libtmux.Server.windows
Clojure libtmux.core/windows! Acquires a new graph and returns its window placements without deduplicating linked windows.
Kotlin io.github.libtmux.kotlin.Server.windows
Scala io.github.libtmux.scaladsl.Server.windows
C# LibTmux.Server.Windows
F# LibTmux.FSharp.Server.windows Builds a deferred query for placements across all sessions. Query.list acquires the results; a linked window appears once for each session placement.
C++ libtmux::Server::windows
Swift Server.windows()
OCaml Libtmux.Snapshot.windows Reads captured global windows; use window_links for indexed session placements.
Perl LibTmux::Snapshot::windows One entry per physical identity. window_links retains all session placements.
Esc

Type to search.

Reference previewOpen reference