Selection.one_or_nil
LibTmux Behavior: Selections.
Source and package
- Module
- LibTmux
- Declared in
- Selection
- Package
- libtmux
- Source
- gems/libtmux/lib/libtmux/selection.rb
-
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 4.0.7, Bundler, Git and tmux 3.2a or newer on Unix, with /bin/cat and /bin/sh available. In an empty directory, fetch the documented library revision:
Terminal window $ git clone https://github.com/libtmux/libtmux-ruby.git libtmux-source && \git -C libtmux-source checkout dcc9f8b5a6970144a9e7d80cd5f381d8f6198372Save this dependency file as Gemfile:
source "https://rubygems.org"gem "libtmux", path: "libtmux-source/gems/libtmux"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: truerequire "libtmux"beginLibTmux::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}"endrescue StandardError => errorwarn "#{error.class}: #{error.message}"exit 1endInstall the runtime dependencies and run the saved program. An operation or cleanup error makes it exit unsuccessfully:
Terminal window $ bundle config set --local path vendor/bundle && \bundle install --jobs 2 && \bundle exec ruby query.rbExpected output:
matching session: workmissing session: truematching pane: %0Discussed in Getting started · Ownership and errors