api.md

Public API

Generated by scripts/types; edit the contract manifest and behavior reference.

Every row links an exported public method to its implementation, shipped return declaration and behavioral contract. Inherited project methods and generated metadata readers are included. Ruby builtins, private constants and internal helpers are excluded. Optional arguments and overloads remain in the shipped RBS files; concrete defaults are described by the contracts and linked implementation.

Methods inherited by LibTmux::Async classes also follow the Async scope scheduling and ownership contract.

This inventory checks declaration presence and visibility. The installed signature consumers check exercised calls; neither is whole-program static type checking. See signature proof.

LibTmux::Async

Method	Declared return	Contract
.open	T	Async scope

LibTmux::Async::ControlConnection

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Control connections
#close	nil	Control connections
#closed?	bool	Control connections
#diagnostics	{ admitted_requests: ::Integer, incomplete_requests: ::Integer, queued_requests: ::Integer, writing_requests: ::Integer, awaiting_reply: ::Integer, reserved_wire_bytes: ::Integer, retained_reply_bytes: ::Integer, stderr_received_bytes: ::Integer, subscription_count: ::Integer, stopping: bool, finished: bool, cleanup_error_count: ::Integer, limits: { max_requests: ::Integer, max_command_bytes: ::Integer, max_queue_bytes: ::Integer, max_line_bytes: ::Integer, max_reply_bytes: ::Integer, max_stderr_bytes: ::Integer, max_subscriptions: ::Integer } }	Diagnostics
#events	::LibTmux::Async::ControlSubscription	Control connections
#exchange	::LibTmux::GuardedReply	Control connections
#generation	::String	Control connections
#inspect	::String	Control connections
#pause_output	::LibTmux::GuardedReply	Control flow
#pid	::Integer	Control connections
#previous_generation	::String?	Control connections
#resume_output	::LibTmux::GuardedReply	Control flow
#subscribe	::LibTmux::Async::ControlSubscription	Control connections
.new	::LibTmux::Async::ControlConnection	Control connections
.open	T / ::LibTmux::ControlConnection	Control connections

LibTmux::Async::ControlSubscription

Method	Declared return	Contract
#close	nil	Control subscriptions
#closed?	bool	Control subscriptions
#diagnostics	{ queued_events: ::Integer, retained_event_bytes: ::Integer, gap_pending: bool, overflowed: bool, closed: bool, mode: :reliable | :tail, limits: { max_bytes: ::Integer, max_events: ::Integer } }	Diagnostics
#each	self / ::Enumerator[::LibTmux::ControlEvent, self]	Control subscriptions
#generation	::String?	Control subscriptions
#inspect	::String	Control subscriptions
#next	::LibTmux::ControlEvent	Control subscriptions
.new	::LibTmux::Async::ControlSubscription	Control subscriptions

LibTmux::Async::Scope

Method	Declared return	Contract
#close	nil	Async scope
#closed?	bool	Async scope
#diagnostics	::LibTmux::Async::scope_diagnostics	Diagnostics
#map	::Array[Output]	Async map
#server	::LibTmux::Async::Server	Async scope
.new	::LibTmux::Async::Scope	Async scope

LibTmux::Async::Server

Method	Declared return	Contract
#attach	bot	Async unsupported operations
#close	nil	Async scope
#delete_buffer	::LibTmux::CommandResult	Buffers
#diagnostics	::LibTmux::Async::scope_diagnostics	Diagnostics
#display	::LibTmux::CommandResult	Formats
#endpoint	::LibTmux::Endpoint	Borrowed bindings
#environment	::String?	Environment
#explain_panes	::Hash[::Symbol, untyped]	Source query plans
#hooks	::LibTmux::Hooks	Options and hooks
#kill	::LibTmux::CommandResult	Killing daemons
#list_buffers	::Array[{ name: ::String, size: ::Integer }]	Buffers
#list_clients	::Array[{ name: ::String, pid: ::Integer, created: ::Integer, tty: ::String?, session_id: ::String?, control: bool }]	Live acquisition
#list_panes	::Array[::LibTmux::Pane]	Live acquisition
#list_sessions	::Array[::LibTmux::Session]	Live acquisition
#list_window_links	::Array[::LibTmux::WindowLink]	Live acquisition
#list_windows	::Array[::LibTmux::Window]	Live acquisition
#new_session	::LibTmux::CreationReceipt / ::LibTmux::Session	Creation
#open_control	T / ::LibTmux::Async::ControlConnection	Control connections
#options	::LibTmux::Options	Options and hooks
#owned?	bool	Borrowed bindings
#pane	::LibTmux::Pane	Live handles
#read_buffer	::LibTmux::CommandResult	Buffers
#run	::LibTmux::CommandResult	Raw commands
#run_group	::LibTmux::GroupResult	Command groups
#search_panes	::LibTmux::Selection[::LibTmux::PaneSnapshot]	Source query execution
#session	::LibTmux::Session	Live handles
#set_environment	::LibTmux::CommandResult	Environment
#snapshot	::LibTmux::Snapshot	Snapshot acquisition
#source_file	::LibTmux::CommandResult	Source files
#switch_client	::LibTmux::CommandResult	Client switching
#unset_environment	::LibTmux::CommandResult	Environment
#wait_for	::LibTmux::CommandResult	Wait channels
#window	::LibTmux::Window	Live handles
#window_link	::LibTmux::WindowLink	Live handles
#write_buffer	::LibTmux::CommandResult	Buffers
.new	::LibTmux::Async::Server	Async scope
.open	T / ::LibTmux::Server	Borrowed bindings
.start	bot	Async unsupported operations

LibTmux::Cancellation

Method	Declared return	Contract
#cancel	void	Cancellation tokens
#cancelled?	bool	Cancellation tokens
#close	void	Cancellation tokens
#reader	::IO	Cancellation tokens
.new	::LibTmux::Cancellation	Cancellation tokens

LibTmux::Cancelled

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::Cancelled	Errors

LibTmux::CapacityError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::CapacityError	Errors

LibTmux::CapturedRecord

Method	Declared return	Contract
#==	bool	Captured records
#capture_id	::String	Captured records
#eql?	bool	Captured records
#hash	::Integer	Captured records
#inspect	::String	Captured records
#raw	::String?	Captured records
#ref	::LibTmux::EntityRef	Captured records

LibTmux::ClientSnapshot

Method	Declared return	Contract
#==	bool	Captured records
#capture_id	::String	Captured records
#control_mode	bool	Captured records
#control_mode?	bool	Captured records
#created	::Integer	Captured records
#eql?	bool	Captured records
#hash	::Integer	Captured records
#height	::Integer?	Captured records
#inspect	::String	Captured records
#name	::String	Captured records
#pid	::Integer	Captured records
#raw	::String?	Captured records
#read_only	bool	Captured records
#read_only?	bool	Captured records
#ref	::LibTmux::EntityRef	Captured records
#session	::LibTmux::SessionSnapshot?	Captured records
#session_id	::String?	Captured records
#tty	::String?	Captured records
#utf8	bool	Captured records
#utf8?	bool	Captured records
#width	::Integer	Captured records

LibTmux::ClientWhere

Method	Declared return	Contract
.build	::LibTmux::FilterExpr	Criteria

LibTmux::ClosedError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::ClosedError	Errors

LibTmux::CommandError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
#result	::LibTmux::CommandResult?	Errors
.new	::LibTmux::CommandError	Errors

LibTmux::CommandResult

Method	Declared return	Contract
#argv	::Array[::String]	Command evidence
#delivery	:observed	Command evidence
#elapsed_seconds	::Float	Command evidence
#inspect	::String	Command evidence
#pid	::Integer	Command evidence
#status	::Process::Status	Command evidence
#stderr	::String	Command evidence
#stdout	::String	Command evidence
#success?	bool	Command evidence
#text	::String	Command evidence
.new	::LibTmux::CommandResult	Command evidence

LibTmux::ControlConnection

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Control connections
#close	nil	Control connections
#closed?	bool	Control connections
#diagnostics	{ admitted_requests: ::Integer, incomplete_requests: ::Integer, queued_requests: ::Integer, writing_requests: ::Integer, awaiting_reply: ::Integer, reserved_wire_bytes: ::Integer, retained_reply_bytes: ::Integer, stderr_received_bytes: ::Integer, subscription_count: ::Integer, stopping: bool, finished: bool, cleanup_error_count: ::Integer, limits: { max_requests: ::Integer, max_command_bytes: ::Integer, max_queue_bytes: ::Integer, max_line_bytes: ::Integer, max_reply_bytes: ::Integer, max_stderr_bytes: ::Integer, max_subscriptions: ::Integer } }	Diagnostics
#events	::LibTmux::ControlSubscription	Control connections
#exchange	::LibTmux::GuardedReply	Control connections
#generation	::String	Control connections
#inspect	::String	Control connections
#pause_output	::LibTmux::GuardedReply	Control flow
#pid	::Integer	Control connections
#previous_generation	::String?	Control connections
#resume_output	::LibTmux::GuardedReply	Control flow
#subscribe	::LibTmux::ControlSubscription	Control connections
.new	::LibTmux::ControlConnection	Control connections
.open	T / ::LibTmux::ControlConnection	Control connections

LibTmux::ControlEvent

Method	Declared return	Contract
#bytesize	::Integer	Control evidence
#data	::String?	Control evidence
#dropped_bytes	::Integer?	Control evidence
#generation	::String?	Control evidence
#inspect	::String	Control evidence
#kind	::Symbol	Control evidence
#lost_sequences	::Array[::Integer]?	Control evidence
#pane_id	::String?	Control evidence
#previous_generation	::String?	Control evidence
#raw	::String	Control evidence
#reason	::Symbol?	Control evidence
#sequence	::Integer?	Control evidence
.new	::LibTmux::ControlEvent	Control evidence

LibTmux::ControlSubscription

Method	Declared return	Contract
#close	nil	Control subscriptions
#closed?	bool	Control subscriptions
#diagnostics	{ queued_events: ::Integer, retained_event_bytes: ::Integer, gap_pending: bool, overflowed: bool, closed: bool, mode: :reliable | :tail, limits: { max_bytes: ::Integer, max_events: ::Integer } }	Diagnostics
#each	self / ::Enumerator[::LibTmux::ControlEvent, self]	Control subscriptions
#generation	::String?	Control subscriptions
#inspect	::String	Control subscriptions
#next	::LibTmux::ControlEvent	Control subscriptions
.new	::LibTmux::ControlSubscription	Control subscriptions

LibTmux::CreationReceipt

Method	Declared return	Contract
#entity	::LibTmux::Session | ::LibTmux::Window	Entity references
#inspect	::String	Entity references
#pane	::LibTmux::Pane	Entity references
#result	::LibTmux::CommandResult	Entity references
#window	::LibTmux::Window	Entity references

LibTmux::DeadlineExceeded

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::DeadlineExceeded	Errors

LibTmux::Endpoint

Method	Declared return	Contract
#==	bool	Endpoints
#eql?	bool	Endpoints
#executable	::String	Endpoints
#hash	::Integer	Endpoints
#inspect	::String	Endpoints
#socket_path	::String	Endpoints
.from_env	::LibTmux::Endpoint	Endpoints
.new	::LibTmux::Endpoint	Endpoints

LibTmux::Entity

Method	Declared return	Contract
#==	bool	Live handles
#display	::LibTmux::CommandResult	Formats
#eql?	bool	Live handles
#hash	::Integer	Live handles
#hooks	::LibTmux::Hooks	Options and hooks
#id	::String	Live handles
#inspect	::String	Live handles
#kill	::LibTmux::CommandResult	Entity removal
#options	::LibTmux::Options	Options and hooks
#ref	::LibTmux::EntityRef	Live handles
#server	::LibTmux::Server	Live handles
#snapshot	::LibTmux::CapturedRecord	Snapshot acquisition

LibTmux::EntityRef

Method	Declared return	Contract
#==	bool	Entity references
#binding_key	::String	Entity references
#eql?	bool	Entity references
#hash	::Integer	Entity references
#id	::String	Entity references
#index	::Integer?	Entity references
#inspect	::String	Entity references
#kind	:session | :window | :pane | :window_link	Entity references
#session_id	::String?	Entity references

LibTmux::Error

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::Error	Errors

LibTmux::FieldDecodeError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::FieldDecodeError	Errors

LibTmux::FilterExpr

Method	Declared return	Contract
#===	bool	Criteria
#and	::LibTmux::FilterExpr	Criteria
#call	bool	Criteria
#entity	::Symbol	Criteria
#inspect	::String	Criteria
#not	::LibTmux::FilterExpr	Criteria
#or	::LibTmux::FilterExpr	Criteria
#to_h	::Hash[::String, untyped]	Criteria
#to_json	::String	Criteria
#to_proc	^(untyped) -> bool	Criteria
.build	::LibTmux::FilterExpr	Criteria
.from_json	::LibTmux::FilterExpr	Criteria
.json_schema	::Hash[::String, untyped]	Criteria

LibTmux::GroupResult

Method	Declared return	Contract
#delivery	:observed	Command groups
#inspect	::String	Command groups
#result	::LibTmux::CommandResult	Command groups
#steps	::Array[::Hash[::Symbol, ::Integer | ::Symbol]]	Command groups
#success?	bool	Command groups

LibTmux::GuardedBlock

Method	Declared return	Contract
#body	::String	Control evidence
#bytesize	::Integer	Control evidence
#guard	::Array[::Integer]	Control evidence
#guard_success?	bool	Control evidence
#inspect	::String	Control evidence
#raw	::String	Control evidence
#terminator	:end | :error	Control evidence
.new	::LibTmux::GuardedBlock	Control evidence

LibTmux::GuardedReply

Method	Declared return	Contract
#attribution	:boundary_window	Control evidence
#blocks	::Array[::LibTmux::GuardedBlock]	Control evidence
#delivery	:observed	Control evidence
#generation	::String	Control evidence
#inspect	::String	Control evidence
#request_id	::Integer	Control evidence
.new	::LibTmux::GuardedReply	Control evidence

LibTmux::Hooks

Method	Declared return	Contract
#get	::LibTmux::OptionValue	Options and hooks
#list	::Array[::LibTmux::OptionValue]	Options and hooks
#run	::LibTmux::CommandResult	Options and hooks
#set	::LibTmux::CommandResult	Options and hooks
#unset	::LibTmux::CommandResult	Options and hooks

LibTmux::IncompleteSnapshotError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::IncompleteSnapshotError	Errors

LibTmux::InconsistentSnapshotError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::InconsistentSnapshotError	Errors

LibTmux::InvalidFilterError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::InvalidFilterError	Errors

LibTmux::MCP::Application

Method	Declared return	Contract
#accept_shell	::LibTmux::EntityRef	MCP application
#call	untyped	MCP application
#close	nil	MCP application
#inspect	::String	MCP application
#invite_shell	::LibTmux::MCP::_ShellInvitation	MCP application
#sdk_server	untyped	MCP application
#tools	::Array[untyped]	MCP application
.new	::LibTmux::MCP::Application	MCP application

LibTmux::MCP::CLI

Method	Declared return	Contract
#run	::Integer	MCP CLI
.run	::Integer	MCP CLI

LibTmux::MCP::StdioTransport

Method	Declared return	Contract
#close	nil	MCP transport
#closed?	bool	MCP transport
#run	nil	MCP transport
#send_notification	bool	MCP transport
#send_request	bot	MCP transport
#send_response	nil	MCP transport
.new	::LibTmux::MCP::StdioTransport	MCP transport

LibTmux::MultipleMatchesError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::MultipleMatchesError	Errors

LibTmux::NoMatchError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::NoMatchError	Errors

LibTmux::OptionValue

Method	Declared return	Contract
#array?	bool	Option values
#as	::String / ::Integer / bool	Option values
#index	::Integer?	Option values
#inherited?	bool	Option values
#name	::String	Option values
#present?	bool	Option values
#raw	::String	Option values

LibTmux::Options

Method	Declared return	Contract
#get	::LibTmux::OptionValue	Options and hooks
#list	::Array[::LibTmux::OptionValue]	Options and hooks
#set	::LibTmux::CommandResult	Options and hooks
#unset	::LibTmux::CommandResult	Options and hooks

LibTmux::OutcomeUnknown

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::OutcomeUnknown	Errors

LibTmux::Pane

Method	Declared return	Contract
#==	bool	Live handles
#break_out	::LibTmux::Window	Entity mutation
#capture	::LibTmux::CommandResult	Pane input and capture
#copy_command	::LibTmux::CommandResult	Copy mode
#copy_mode	::LibTmux::CommandResult	Copy mode
#display	::LibTmux::CommandResult	Formats
#eql?	bool	Live handles
#hash	::Integer	Live handles
#hooks	::LibTmux::Hooks	Options and hooks
#id	::String	Live handles
#inspect	::String	Live handles
#join	::LibTmux::CommandResult	Entity mutation
#kill	::LibTmux::CommandResult	Entity removal
#move	::LibTmux::CommandResult	Entity mutation
#options	::LibTmux::Options	Options and hooks
#paste	::LibTmux::CommandResult	Pane input and capture
#pipe	::LibTmux::CommandResult	Pane pipes
#ref	::LibTmux::EntityRef	Live handles
#resize	::LibTmux::CommandResult	Entity mutation
#respawn	::LibTmux::CommandResult	Entity mutation
#select	::LibTmux::CommandResult	Entity mutation
#send_keys	::LibTmux::CommandResult	Pane input and capture
#send_text	::LibTmux::CommandResult	Pane input and capture
#server	::LibTmux::Server	Live handles
#snapshot	::LibTmux::PaneSnapshot	Snapshot acquisition
#split	::LibTmux::Pane	Creation
#swap	::LibTmux::CommandResult	Entity mutation

LibTmux::PaneSnapshot

Method	Declared return	Contract
#==	bool	Captured records
#active	bool	Captured records
#active?	bool	Captured records
#capture_id	::String	Captured records
#current_command	::String	Captured records
#current_path	::String?	Captured records
#dead	bool	Captured records
#dead?	bool	Captured records
#dead_status	::Integer?	Captured records
#eql?	bool	Captured records
#hash	::Integer	Captured records
#height	::Integer	Captured records
#id	::String	Captured records
#index	::Integer	Captured records
#inspect	::String	Captured records
#pid	::Integer	Captured records
#raw	::String?	Captured records
#ref	::LibTmux::EntityRef	Captured records
#title	::String	Captured records
#width	::Integer	Captured records
#window	::LibTmux::WindowSnapshot	Captured records
#window_id	::String	Captured records

LibTmux::PaneWhere

Method	Declared return	Contract
.build	::LibTmux::FilterExpr	Criteria

LibTmux::ProtocolError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::ProtocolError	Errors

LibTmux::Selection

Method	Declared return	Contract
#each	self / ::Enumerator[Elem, self]	Selections
#empty?	bool	Selections
#exists?	bool	Selections
#filter	::LibTmux::Selection[Elem] / ::Enumerator[Elem, ::LibTmux::Selection[Elem]]	Selections
#find_all	::LibTmux::Selection[Elem] / ::Enumerator[Elem, ::LibTmux::Selection[Elem]]	Selections
#length	::Integer	Selections
#one	Elem	Selections
#one_or_nil	Elem?	Selections
#reject	::LibTmux::Selection[Elem] / ::Enumerator[Elem, ::LibTmux::Selection[Elem]]	Selections
#select	::LibTmux::Selection[Elem] / ::Enumerator[Elem, ::LibTmux::Selection[Elem]]	Selections
#size	::Integer	Selections
#to_a	::Array[Elem]	Selections
#where	::LibTmux::Selection[Elem]	Selections
.new	::LibTmux::Selection[Elem]	Selections

LibTmux::Server

Method	Declared return	Contract
#attach	::LibTmux::TerminalResult	Terminal attachment
#close	nil	Closing bindings
#delete_buffer	::LibTmux::CommandResult	Buffers
#diagnostics	{ admitted_requests: ::Integer, reserved_process_slots: ::Integer, control_connections: ::Integer, closed: bool, limits: { max_requests: ::Integer, max_controls: ::Integer, close_timeout: ::Numeric } }	Diagnostics
#display	::LibTmux::CommandResult	Formats
#endpoint	::LibTmux::Endpoint	Borrowed bindings
#environment	::String?	Environment
#explain_panes	::Hash[::Symbol, untyped]	Source query plans
#hooks	::LibTmux::Hooks	Options and hooks
#kill	::LibTmux::CommandResult	Killing daemons
#list_buffers	::Array[{ name: ::String, size: ::Integer }]	Buffers
#list_clients	::Array[{ name: ::String, pid: ::Integer, created: ::Integer, tty: ::String?, session_id: ::String?, control: bool }]	Live acquisition
#list_panes	::Array[::LibTmux::Pane]	Live acquisition
#list_sessions	::Array[::LibTmux::Session]	Live acquisition
#list_window_links	::Array[::LibTmux::WindowLink]	Live acquisition
#list_windows	::Array[::LibTmux::Window]	Live acquisition
#new_session	::LibTmux::CreationReceipt / ::LibTmux::Session	Creation
#open_control	T / ::LibTmux::ControlConnection	Control connections
#options	::LibTmux::Options	Options and hooks
#owned?	bool	Borrowed bindings
#pane	::LibTmux::Pane	Live handles
#read_buffer	::LibTmux::CommandResult	Buffers
#run	::LibTmux::CommandResult	Raw commands
#run_group	::LibTmux::GroupResult	Command groups
#search_panes	::LibTmux::Selection[::LibTmux::PaneSnapshot]	Source query execution
#session	::LibTmux::Session	Live handles
#set_environment	::LibTmux::CommandResult	Environment
#snapshot	::LibTmux::Snapshot	Snapshot acquisition
#source_file	::LibTmux::CommandResult	Source files
#switch_client	::LibTmux::CommandResult	Client switching
#unset_environment	::LibTmux::CommandResult	Environment
#wait_for	::LibTmux::CommandResult	Wait channels
#window	::LibTmux::Window	Live handles
#window_link	::LibTmux::WindowLink	Live handles
#write_buffer	::LibTmux::CommandResult	Buffers
.new	::LibTmux::Server	Borrowed bindings
.open	T / ::LibTmux::Server	Borrowed bindings
.start	::LibTmux::Server / T	Owned daemons

LibTmux::Session

Method	Declared return	Contract
#==	bool	Live handles
#display	::LibTmux::CommandResult	Formats
#environment	::String?	Environment
#eql?	bool	Live handles
#hash	::Integer	Live handles
#hooks	::LibTmux::Hooks	Options and hooks
#id	::String	Live handles
#inspect	::String	Live handles
#kill	::LibTmux::CommandResult	Entity removal
#link_window	::LibTmux::CommandResult	Window links
#list_panes	::Array[::LibTmux::Pane]	Live acquisition
#list_window_links	::Array[::LibTmux::WindowLink]	Live acquisition
#list_windows	::Array[::LibTmux::Window]	Live acquisition
#new_window	::LibTmux::CreationReceipt / ::LibTmux::Window	Creation
#options	::LibTmux::Options	Options and hooks
#ref	::LibTmux::EntityRef	Live handles
#rename	::LibTmux::CommandResult	Entity mutation
#server	::LibTmux::Server	Live handles
#set_environment	::LibTmux::CommandResult	Environment
#snapshot	::LibTmux::SessionSnapshot	Snapshot acquisition
#unset_environment	::LibTmux::CommandResult	Environment

LibTmux::SessionSnapshot

Method	Declared return	Contract
#==	bool	Captured records
#attached	::Integer	Captured records
#capture_id	::String	Captured records
#created	::Integer	Captured records
#current_window	::LibTmux::WindowSnapshot?	Captured records
#eql?	bool	Captured records
#hash	::Integer	Captured records
#id	::String	Captured records
#inspect	::String	Captured records
#name	::String	Captured records
#panes	::LibTmux::Selection[::LibTmux::PaneSnapshot]	Captured records
#raw	::String?	Captured records
#ref	::LibTmux::EntityRef	Captured records
#window_count	::Integer	Captured records
#window_links	::LibTmux::Selection[::LibTmux::WindowLinkSnapshot]	Captured records
#windows	::LibTmux::Selection[::LibTmux::WindowSnapshot]	Captured records

LibTmux::SessionWhere

Method	Declared return	Contract
.build	::LibTmux::FilterExpr	Criteria

LibTmux::Snapshot

Method	Declared return	Contract
#binding_key	::String	Captured records
#capture_id	::String	Captured records
#clients	::LibTmux::Selection[::LibTmux::ClientSnapshot]	Captured records
#coverage	::Hash[::Symbol, untyped]	Captured records
#finished_at	::Float	Captured records
#inspect	::String	Captured records
#panes	::LibTmux::Selection[::LibTmux::PaneSnapshot]	Captured records
#reads	::Array[::Hash[::Symbol, untyped]]	Captured records
#resolve	::LibTmux::CapturedRecord	Captured records
#server_info	::Hash[::Symbol, untyped]	Captured records
#sessions	::LibTmux::Selection[::LibTmux::SessionSnapshot]	Captured records
#started_at	::Float	Captured records
#window_links	::LibTmux::Selection[::LibTmux::WindowLinkSnapshot]	Captured records
#windows	::LibTmux::Selection[::LibTmux::WindowSnapshot]	Captured records

LibTmux::SubscriptionOverflow

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
#sequence	::Integer?	Errors
.new	::LibTmux::SubscriptionOverflow	Errors

LibTmux::TargetNotFoundError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::TargetNotFoundError	Errors

LibTmux::TerminalResult

Method	Declared return	Contract
#delivery	:observed	Command evidence
#elapsed_seconds	::Float	Command evidence
#inspect	::String	Command evidence
#pid	::Integer	Command evidence
#status	::Process::Status	Command evidence
#success?	bool	Command evidence

LibTmux::TransportError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::TransportError	Errors

LibTmux::UnsupportedFeatureError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::UnsupportedFeatureError	Errors

LibTmux::Window

Method	Declared return	Contract
#==	bool	Live handles
#display	::LibTmux::CommandResult	Formats
#eql?	bool	Live handles
#hash	::Integer	Live handles
#hooks	::LibTmux::Hooks	Options and hooks
#id	::String	Live handles
#inspect	::String	Live handles
#kill	::LibTmux::CommandResult	Entity removal
#list_panes	::Array[::LibTmux::Pane]	Live acquisition
#options	::LibTmux::Options	Options and hooks
#ref	::LibTmux::EntityRef	Live handles
#rename	::LibTmux::CommandResult	Entity mutation
#resize	::LibTmux::CommandResult	Entity mutation
#respawn	::LibTmux::CommandResult	Entity mutation
#select_layout	::LibTmux::CommandResult	Entity mutation
#server	::LibTmux::Server	Live handles
#snapshot	::LibTmux::WindowSnapshot	Snapshot acquisition
#split	::LibTmux::Pane	Creation

LibTmux::WindowLink

Method	Declared return	Contract
#==	bool	Live handles
#display	::LibTmux::CommandResult	Formats
#eql?	bool	Live handles
#hash	::Integer	Live handles
#hooks	::LibTmux::Hooks	Options and hooks
#id	::String	Live handles
#index	::Integer	Live handles
#inspect	::String	Live handles
#kill	::LibTmux::CommandResult	Window links
#move	::LibTmux::CommandResult	Window links
#options	::LibTmux::Options	Options and hooks
#ref	::LibTmux::EntityRef	Live handles
#select	::LibTmux::CommandResult	Window links
#server	::LibTmux::Server	Live handles
#session	::LibTmux::Session	Live handles
#snapshot	::LibTmux::WindowLinkSnapshot	Snapshot acquisition
#swap	::LibTmux::CommandResult	Window links
#unlink	::LibTmux::CommandResult	Window links
#window	::LibTmux::Window	Live handles

LibTmux::WindowLinkSnapshot

Method	Declared return	Contract
#==	bool	Captured records
#active	bool	Captured records
#active?	bool	Captured records
#capture_id	::String	Captured records
#eql?	bool	Captured records
#hash	::Integer	Captured records
#index	::Integer	Captured records
#inspect	::String	Captured records
#raw	::String?	Captured records
#ref	::LibTmux::EntityRef	Captured records
#session	::LibTmux::SessionSnapshot	Captured records
#session_id	::String	Captured records
#window	::LibTmux::WindowSnapshot	Captured records
#window_id	::String	Captured records

LibTmux::WindowLinkWhere

Method	Declared return	Contract
.build	::LibTmux::FilterExpr	Criteria

LibTmux::WindowSnapshot

Method	Declared return	Contract
#==	bool	Captured records
#active_pane	::LibTmux::PaneSnapshot?	Captured records
#capture_id	::String	Captured records
#eql?	bool	Captured records
#hash	::Integer	Captured records
#height	::Integer	Captured records
#id	::String	Captured records
#inspect	::String	Captured records
#layout	::String	Captured records
#name	::String	Captured records
#pane_count	::Integer	Captured records
#panes	::LibTmux::Selection[::LibTmux::PaneSnapshot]	Captured records
#raw	::String?	Captured records
#ref	::LibTmux::EntityRef	Captured records
#width	::Integer	Captured records
#window_links	::LibTmux::Selection[::LibTmux::WindowLinkSnapshot]	Captured records

LibTmux::WindowWhere

Method	Declared return	Contract
.build	::LibTmux::FilterExpr	Criteria

LibTmux::Workspace

Method	Declared return	Contract
#inspect	::String	Workspace parsing
#plan	::LibTmux::Workspace::Plan	Workspace parsing
#to_h	::Hash[::String, untyped]	Workspace parsing
.load	::LibTmux::Workspace	Workspace parsing
.parse	::LibTmux::Workspace	Workspace parsing

LibTmux::Workspace::ApplyError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#failure_class	::String	Workspace results
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
#result	::LibTmux::Workspace::ApplyResult	Workspace results
.new	::LibTmux::Workspace::ApplyError	Workspace results

LibTmux::Workspace::ApplyResult

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Workspace results
#compensation	:not_requested | :nothing_owned | :completed | :failed	Workspace results
#completed_steps	::Array[::Integer]	Workspace results
#created_refs	::Hash[::String, ::LibTmux::EntityRef]	Workspace results
#effects	::Array[::LibTmux::Workspace::ApplyResult::Effect]	Workspace results
#failed_action	::Symbol?	Workspace results
#failed_step	::Integer?	Workspace results
#inspect	::String	Workspace results
#success?	bool	Workspace results
#to_h	::Hash[::String, untyped]	Workspace results
#uncertain?	bool	Workspace results

LibTmux::Workspace::ApplyResult::Effect

Method	Declared return	Contract
#action	::Symbol	Workspace results
#outcome	:observed | :dispatch_only	Workspace results
#step_id	::Integer?	Workspace results
.[]	instance	Workspace results
.inspect	::String	Workspace results
.members	::Array[::Symbol]	Workspace results
.new	instance	Workspace results

LibTmux::Workspace::CLI

Method	Declared return	Contract
#run	::Integer	Workspace CLI
.run	::Integer	Workspace CLI

LibTmux::Workspace::ConfigError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::Workspace::ConfigError	Workspace parsing

LibTmux::Workspace::ConflictError

Method	Declared return	Contract
#cleanup_errors	::Array[::String]	Errors
#delivery	::Symbol	Errors
#entity	::Symbol?	Errors
#expected	::String?	Errors
#path	::String?	Errors
#phase	::Symbol?	Errors
#pid	::Integer?	Errors
.new	::LibTmux::Workspace::ConflictError	Errors

LibTmux::Workspace::Plan

Method	Declared return	Contract
#apply	::LibTmux::Workspace::ApplyResult	Workspace apply
#inspect	::String	Workspace plans
#mode	:offline_create | :captured_create	Workspace plans
#preconditions	::Hash[::String, ::String?]	Workspace plans
#steps	::Array[::LibTmux::Workspace::Plan::Step]	Workspace plans
#to_h	::Hash[::String, untyped]	Workspace plans
.new	::LibTmux::Workspace::Plan	Workspace plans

LibTmux::Workspace::Plan::Step

Method	Declared return	Contract
#arguments	::Hash[::String, untyped]	Workspace plans
#effect	::Symbol	Workspace plans
#id	::Integer	Workspace plans
#inspect	::String	Workspace plans
#operation	::Symbol	Workspace plans
#produces	::Array[::String]	Workspace plans
#target	::String	Workspace plans
.[]	instance	Workspace plans
.inspect	::String	Workspace plans
.members	::Array[::Symbol]	Workspace plans
.new	instance	Workspace plans