Core LibraryalphaAPI Reference

Choose documentation 1

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

struct libtmux-elixir latest

Ref

An exact observed target bound to one server instance.

Source and package
Qualified name
LibTmux.Ref
Module
LibTmux
Package
libtmux
Source
lib/libtmux/ref.ex
struct LibTmux.Ref

Description#

A window-link ID is its observed {session_id, index, window_id} binding, not a unique lifetime identifier. Validation detects known stale instances; it does not reserve an object or close a one-shot check/use race.

Discussed in Read values, execute explicitly

Members9#

Common operations2#

Other members7#

  • entity: entity() property Required: building the struct without this key is an error.
  • entity/0: entity() :: :session | :window | :pane | :window_link | :client typealias The target kind; physical windows and session-relative links have different identities.
  • id: id() property Required: building the struct without this key is an error.
  • new/3 function Validates a native identity and binds it to a nonempty instance token.
  • server_instance: String.t() property Required: building the struct without this key is an error.
  • t/0: t() :: %LibTmux.Ref{ entity: entity(), id: id(), server_instance: String.t() } typealias An exact observed identity bound to a tmux server incarnation, separate from a connection epoch.
  • validate/2 function Rejects malformed references and known server-instance mismatches.
Esc

Type to search.

Reference preview Open reference