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

Window.search_panes

The panes under this window that a matcher accepts, reporting why if the listing fails.

Source and package
Qualified name
libtmux::window::Window::search_panes
Module
window
Declared in
Window
Package
libtmux
Source
crates/libtmux/src/window/navigation.rs
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript Go Java C# C++ Swift Kotlin Scala OCaml F# Clojure
#[cfg(feature = "query")] pub async fn search_panes<M: crate::query::Matcher<Pane>>( &self, matcher: M, ) -> Result<Vec<Pane>, Error>

Description#

Errors

Returns an error when tmux cannot be reached or refuses the listing.

Examples#

use libtmux::query::Filterable as _;
let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("searched").await?;
let window = session.active_window().await?.expect("a window");
let fields = libtmux::Pane::filter_fields();
let found = window.search_panes(&fields.pane_active.eq(true)).await?;
assert_eq!(found.len(), 1);
guard.shutdown().await?;
Type parameters
Parameters

tmux command#

The tmux commands behind search_panes.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Filter a window's panes with a tmux expression

Equivalents of Filter a window's panes with a tmux expression in other languages
Language Equivalent
Python libtmux.Window.search_panes
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript no equivalent on Window
Go tmux.Window.SearchPanes
Java no equivalent on Window
C# LibTmux.Window.SearchPanesAsync
C++ no equivalent on Window
Swift no equivalent on Window
OCaml No direct public OCaml equivalent is recorded for this operation.
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference