# API reference

Source: https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/

> Types, methods, and functions in libtmux for Ruby.

Browse the Ruby types and operations for working with tmux. Start with the core objects below, or search for a type or member.

Server 1 type

[Server](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-server/) class 40 members

Connects to an existing endpoint. Closing retires clients, never the daemon.

Session 2 types

[Session](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-session-nvps/) class 21 members

[SessionWhere](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-sessionwhere/) module 1 member

Window 4 types

[Window](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-window-1vfx/) class 18 members

[WindowLink](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-windowlink-tusj/) class 19 members

[WindowLinkWhere](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-windowlinkwhere/) module 1 member

[WindowWhere](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-windowwhere/) module 1 member

Pane 2 types

[Pane](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-pane-14z6/) class 27 members

[PaneWhere](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-panewhere/) module 1 member

Client 1 type

[ClientWhere](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-clientwhere/) module 1 member

Hooks 1 type

[Hooks](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-hooks/) class 5 members

Hook values are executable tmux command strings, never literal data.

Options 1 type

[OptionValue](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-optionvalue/) class 7 members

Raw bytes remain available even when a caller requests a typed conversion.

Commands 3 types

[Cancellation](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-cancellation/) class 5 members

[CreationReceipt](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-creationreceipt/) class 5 members

IDs printed by the creation command itself, before later topology changes. A receipt proves creation, not continued ownership or current membership.

[Endpoint](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-endpoint-s6cs/) class 8 members

Explicit executable and socket selection. Construction starts no clients.

Control mode 4 types

[ControlConnection](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-controlconnection/) class 15 members

[ControlSubscription](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-controlsubscription/) class 8 members

[GuardedBlock](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-guardedblock/) class 8 members

[GuardedReply](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-guardedreply/) class 7 members

Blocks observed between private boundaries may include hooks. They do not establish command ownership, final status, or completion of delayed effects.

Queries — Expressions 1 type

[FilterExpr](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-filterexpr-1wz0/) class 13 members

A schema-validated predicate over captured records; evaluation performs no I/O.

Snapshots 8 types

[CapturedRecord](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-capturedrecord-18ay/) class 7 members

[ClientSnapshot](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-clientsnapshot-w08e/) class 21 members

[PaneSnapshot](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-panesnapshot-43mz/) class 22 members

[Selection](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-selection/) class 14 members

Replayable captured membership. Snapshot construction owns record values.

[SessionSnapshot](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-sessionsnapshot-xllu/) class 16 members

[Snapshot](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-snapshot/) class 14 members

A validated graph observed over an interval, with no transport reference.

[WindowLinkSnapshot](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-windowlinksnapshot-vzc2/) class 14 members

[WindowSnapshot](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-windowsnapshot-19c3/) class 16 members

Errors 18 types

[Cancelled](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-cancelled/) class 8 members

[CapacityError](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-capacityerror/) class 8 members

[ClosedError](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-closederror/) class 8 members

[CommandError](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-commanderror/) class 9 members

[DeadlineExceeded](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-deadlineexceeded/) class 8 members

[Error](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-error/) class 8 members

[FieldDecodeError](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-fielddecodeerror/) class 8 members

[IncompleteSnapshotError](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-incompletesnapshoterror/) class 8 members

[InconsistentSnapshotError](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-inconsistentsnapshoterror/) class 8 members

[InvalidFilterError](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-invalidfiltererror/) class 8 members

[MultipleMatchesError](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-multiplematcheserror/) class 8 members

[NoMatchError](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-nomatcherror/) class 8 members

[OutcomeUnknown](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-outcomeunknown/) class 8 members

[ProtocolError](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-protocolerror/) class 8 members

[SubscriptionOverflow](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-subscriptionoverflow/) class 9 members

[TargetNotFoundError](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-targetnotfounderror/) class 8 members

[TransportError](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-transporterror/) class 8 members

[UnsupportedFeatureError](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-unsupportedfeatureerror/) class 8 members

Constants and enums 5 types

[CommandResult](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-commandresult/) class 11 members

[ControlEvent](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-controlevent/) class 13 members

[GroupResult](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-groupresult/) class 5 members

Final client status cannot attribute a merged group result to individual steps.

[Options](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-options/) class 4 members

Explicit acquisition and mutation at one option scope.

[TerminalResult](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-terminalresult/) class 6 members

Terminal bytes go directly to the caller's TTY and are not captured.

Async 1 type

[Async](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-async/) module 6 members

Other 3 types

[Entity](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-entity-bg78/) class 12 members

[EntityRef](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-entityref-162n/) class 9 members

A target belongs to one open server binding; names never identify it.

[Support](https://libtmux.org/en/ruby/v0.1.0.alpha.3/reference/libtmux-support/) module 3 members

Here "support" means which tmux releases libtmux supports, not helper code. Every server handle checks its daemon's release before any command runs; this module exposes that check.
