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.

class libtmux-perl latest

X

Typed failures with readable diagnostics

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

Description#

DESCRIPTION

Errors stringify with class, path, and message. "Creation" retains its original acquisition exception separately through cause. details returns diagnostic fields. Acquisition failures never represent an empty selection.

CARDINALITY AND DATA FAILURES

DIAGNOSTICS

message, path, entity, expected, received, matched_ids, count, result, dispatched, and details expose applicable fields. See "one" in LibTmux::Selection, "new" in LibTmux::Filter, and LibTmux::Server for failure boundaries.

Members12#

Common operations1#

  • details method Return a fresh shallow hashref of diagnostic fields. Causes and entity handles retain their identity.

Other members11#

  • count method Return the observed cardinality lower bound where applicable.
  • dispatched method Return whether the request was submitted where known; undef means no dispatch evidence was recorded. This never proves rollback.
  • entity method Return the entity kind, or undef when inapplicable.
  • expected method Return the expected operand description, or undef.
  • matched_ids method Return a fresh arrayref of observed matching IDs, including duplicate occurrences.
  • message method Return the human-readable failure description.
  • new method new(%details) constructs an exception object without throwing or I/O.
  • path method Return the criterion or argument path, or undef when inapplicable.
  • received method Return the received operand description, or undef.
  • result method Return a completed or bounded partial LibTmux::CommandResult, or undef before process dispatch.
  • throw method throw(%details) throws one exception object of the receiving class.

Guides#

Pages that discuss X.

Esc

Type to search.

Reference previewOpen reference