Ruby API

method libtmux-ruby v0.1.0.alpha.2

Server.snapshot

Module LibTmux

Behavior: Snapshot acquisition.

Source and package

Module: LibTmux
Declared in: Server
Package: libtmux
Source: gems/libtmux/lib/libtmux/server.rb
Other languages: PowerShell (cmdlet)Julia (function) Python Lua TypeScript Rust Go Java C# C++ Swift Kotlin Scala F# (function)

def snapshot: ( ?timeout: ::Numeric, ?cancel: untyped, ?clients: bool, ?max_bytes: ::Integer, ?max_rows: ::Integer, ?max_field_bytes: ::Integer ) -> ::LibTmux::Snapshot method libtmux [source] ¶

Description#

Behavior contract: Snapshot acquisition.

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:

$ git clone https://github.com/libtmux/libtmux-ruby.git libtmux-source && \
  git -C libtmux-source checkout dcc9f8b5a6970144a9e7d80cd5f381d8f6198372

Save 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: true

require "libtmux"

begin
  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
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end

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

$ bundle config set --local path vendor/bundle && \
  bundle install --jobs 2 && \
  bundle exec ruby query.rb

Expected output:

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

In other ports Capture the tmux hierarchy

PowerShell
LibTmux\Get-TmuxSnapshot
Acquires a replacement LibTmux.Server to -Depth (panes by default). Acquisition is not atomic; retained handles do not refresh.
Julia
LibTmux.snapshot
Acquires a new Snapshot over an observation interval. Topology checks do not make it a transaction; earlier snapshots do not refresh.
Python
no equivalent on Server
Lua
libtmux.Server:snapshot
TypeScript
server.Server.snapshot
Rust
no equivalent on Server
Go
tmux.Server.Snapshot
Java
io.github.libtmux.Server.snapshot
C#
LibTmux.Server.CaptureSnapshotAsync
C++
no equivalent on Server
Swift
Server.snapshot()
Kotlin
io.github.libtmux.kotlin.Server.snapshot
Scala
io.github.libtmux.scaladsl.Server.snapshot
F#
LibTmux.FSharp.Server.capture
Acquires a replacement shared .NET LibTmux.Server to the requested depth. Acquisition is not atomic; retained handles do not refresh.

Scripting & web

Compiled & native

JVM

.NET

tmux

Server.snapshot

Description#

Examples#

Description#

Examples#

Related types#