Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased LibTmux has not been released. Its API may change during development. This site's structure and URLs may change too.

Perl API

class libtmux-perl latest

Entity

Read-only handle retaining a captured graph

Source and package
Qualified name
LibTmux::Entity
Module
LibTmux
Package
LibTmux
Source
packages/core/lib/LibTmux/Entity.pm

Description#

DESCRIPTION

Field readers and relationships resolve locally in the retained graph. "to_record" returns detached scalar record data. Handles retain no transport.

EXECUTION

All methods in this module operate on local captured data and perform no tmux I/O. Ordering is deterministic; public query methods do not mutate membership. Typed validation/evaluation errors propagate. See "snapshot" in LibTmux::Server for explicit acquisition and LibTmux::X for machine-readable failures.

Members5#

  • generation method Return the captured generation. Restarted daemons cannot silently reuse this handle.
  • identity method Return an opaque identity key scoped by server, generation, kind, and string ID. It is suitable for local equality; duplicate selection occurrences remain separate occurrences.
  • kind method Return the schema entity-kind string. Concrete public field readers belong to LibTmux::Pane, LibTmux::Window, LibTmux::WindowLink, LibTmux::Session, and LibTmux::Client.
  • server_id method Return the captured server scope. No daemon discovery or refresh occurs.
  • to_record method Return a fresh hash reference of captured scalar fields and adjacency IDs. Editing it does not change the retained graph. Retaining the entity retains its captured graph, with no transport ownership or reference cycle.
Esc

Type to search.

Reference previewOpen reference