Selection.where
Behavior: Selections.
Source and package
- Qualified name
-
LibTmux:: Selection# where - Module
- LibTmux
- Declared in
Selection- Package
- libtmux
- Source
- gems/libtmux/lib/libtmux/selection.rb
- def where: ( ?untyped, **untyped ) -> ::Lib
Tmux:: [Elem]Selection -
Description#
Behavior contract: Selections.
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/catand/bin/shavailable. In an empty directory, save thisGemfile:source "https://rubygems.org"gem "libtmux", "0.1.1"Save this complete program as
query.rb. ItsServer.start()block owns a private tmux server and stops it on exit, including after an error. View source# frozen_string_literal: truebegin# docs:begin mainrequire "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.snapshotsession = snapshot.sessions.where(name: "work").oneputs "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 mainrescue StandardError => errorwarn "#{error.class}: #{error.message}"exit 1endInstall the gem and run the program. An operation or cleanup error makes it exit unsuccessfully:
Terminal window $ bundle install && \bundle exec ruby query.rbExpected output:
matching session: workmissing session: truematching pane: %0