Ruby API

method libtmux-ruby v0.1.1

Server.search_panes

Behavior: Source query execution.

Source and package

Qualified name: LibTmux::Server#search_panes
Module: LibTmux
Declared in: Server
Package: libtmux
Source: gems/libtmux/lib/libtmux/server.rb
Other languages: PowerShell Julia Elixir PythonLua TypeScript Rust Go Java C# C++ Swift Kotlin Scala F#

def search_panes: ( ?where: untyped, ?pushdown: ::Symbol, **untyped ) -> ::LibTmux::Selection[::LibTmux::PaneSnapshot]

method libtmux [source] ¶

Description#

Behavior contract: Source query execution.

Examples#

Filter a captured snapshot, distinguish a missing session, and acquire a fresh pane selection. one raises unless exactly one record matches; one_or_nil returns nil only for zero matches. Use Ruby 3.3 or newer with Bundler, and tmux 3.3a or newer, on Unix with /bin/cat and /bin/sh available. In an empty directory, save this Gemfile:

source "https://rubygems.org"

gem "libtmux", "0.1.1"

Save this complete program as query.rb. Its Server.start() block owns a private tmux server and stops it on exit, including after an error. View source

# frozen_string_literal: true

begin
  # docs:begin main
  require "libtmux"

  LibTmux::Server.start do |server|
    work = server.new_session(name: "work", command: ["/bin/cat"], receipt: true)
    server.new_session(name: "logs", command: ["/bin/cat"])
    snapshot = server.snapshot
    session = snapshot.sessions.where(name: "work").one
    puts "matching session: #{session.name}"
    missing = snapshot.sessions.one_or_nil(name: "missing")
    puts "missing session: #{missing.nil?}"
    panes = server.search_panes(where: {id: work.pane.id})
    puts "matching pane: #{panes.one.id}"
  end
  # docs:end main
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end

Install the gem and run the program. An operation or cleanup error makes it exit unsuccessfully:

$ bundle install && \
  bundle exec ruby query.rb

Expected output:

matching session: work
missing session: true
matching pane: %0

Parameters

where (untyped) #
pushdown (::Symbol) #
kwargs (untyped) #

tmux command#

The tmux commands behind search_panes.

list-panes -a server scope, cmd_list_panes_server

tmux C API#

The C declarations in tmux that implement these commands.

cmd_list_panes_entry cmd_list_panes_server

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`
Lua	`libtmux.Server:query_panes`
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`

No equivalent is recorded in PowerShell, Julia, Elixir, Kotlin, Scala or F#.

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Server.search_panes

Description#

Examples#

tmux command#

tmux C API#

In other ports#

Description#

Examples#

tmux command#

tmux C API#

In other ports#

Related types#