Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased LibTmux has not been released. Its API may change during development. This site's structure and URLs may change too.

method libtmux-perl latest

Server.query_panes

query_panes(where => criteria|Filter?, pushdown => auto|never|require?, native_filter => string?, on_verification => coderef?).

Source and package
Qualified name
LibTmux::Server::query_panes
Module
LibTmux
Declared in
Server
Package
LibTmux
Source
packages/core/lib/LibTmux/Server.pm
Other languages
Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLua TypeScript Rust Go Java C# C++ Swift Kotlin Scala OCaml F# Clojure
sub query_panes($self, %args)

Description#

Acquire and return a new LibTmux::PaneSelection in captured physical-pane order. where accepts a hash reference or LibTmux::Filter. auto verifies safe scalar candidates after complete local evaluation; never disables the native comparison. The default auto costs one extra command and supervisor when lowering is available; it does not reduce acquisition. Select never when only the captured answer is needed. require throws "Unsupported" in LibTmux::X unless lowering is exact, or "QueryMismatch" in LibTmux::X on disagreement. native_filter is an exclusive expert escape hatch. Empty successful matches remain a typed selection; acquisition/evaluation failures propagate.

on_verification receives one detached report hashref in void context after a successful decision, including auto fallback. It runs inline once; its return is ignored and exceptions propagate unchanged unless the operation has already been cancelled. Cancellation suppresses subsequent result/error delivery. Failed queries do not invoke it. Report edits cannot change the returned selection. See "VERIFICATION REPORT" and "explain_panes".

my $panes = $server->query_panes(where => {active => true}, pushdown => 'auto');

Methods#

Parameters

tmux command#

The tmux commands behind query_panes.

display-message (daemon identity or target preflight) list-clients list-panes -a server scope, cmd_list_panes_server list-sessions list-windows -a server scope, cmd_list_windows_exec

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Filter every pane with a tmux expression

Equivalents of Filter every pane with a tmux expression in other languages
Language Equivalent
Python libtmux.Server.search_panes
Ruby LibTmux::Server#search_panes
Lua libtmux.Server:query_panes
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript no equivalent on Server
Rust no equivalent on Server
Go tmux.Server.SearchPanes
Java no equivalent on Server
C# LibTmux.Server.SearchPanesAsync
C++ no equivalent on Server
Swift no equivalent on Server
OCaml No direct public OCaml equivalent is recorded for this operation.

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

Esc

Type to search.

Reference previewOpen reference