Ruby API

method libtmux-ruby v0.1.1

Server.snapshot

Behavior: Snapshot acquisition.

Source and package

Qualified name: LibTmux::Server#snapshot
Module: LibTmux
Declared in: Server
Package: libtmux
Source: gems/libtmux/lib/libtmux/server.rb
Other languages: PowerShellcmdlet Juliafunction Elixirfunction Python LuaTypeScript Rust GoJavaC# C++ SwiftKotlinScalaF#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 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

timeout (::Numeric) #
cancel (untyped) #
clients (bool) #
max_bytes (::Integer) #
max_rows (::Integer) #
max_field_bytes (::Integer) #

tmux command#

The tmux commands behind snapshot.

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.

cmd_list_clients_entry cmd_list_clients_exec cmd_list_panes_entry cmd_list_panes_server cmd_list_sessions_entry cmd_list_sessions_exec cmd_list_windows_entry cmd_list_windows_exec

In other ports#

Capture the tmux hierarchy

Equivalents of Capture the tmux hierarchy in other languages
Language	Equivalent
Python	no equivalent on `Server`
Lua	`libtmux.Server:snapshot`
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.
Elixir	`LibTmux.Server.snapshot/2` Captures a new graph over an observation interval. A retained `Snapshot` never refreshes.
TypeScript	`server.Server.snapshot`
Rust	no equivalent on `Server`
Go	`tmux.Server.Snapshot`
Java	`io.github.libtmux.Server.snapshot`
Kotlin	`io.github.libtmux.kotlin.Server.snapshot`
Scala	`io.github.libtmux.scaladsl.Server.snapshot`
C#	`LibTmux.Server.CaptureSnapshotAsync`
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.
C++	no equivalent on `Server`
Swift	`Server.snapshot()`

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Server.snapshot

Description#

Examples#

tmux command#

tmux C API#

In other ports#

Description#

Examples#

tmux command#

tmux C API#

In other ports#

Related types#