Workspace ManagerconceptAPI 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.

Workspace Manager: API Reference

LibTmux::Workspace::X::Load

Bases:

cause retains the original exception. report records completed steps, the failed step, dispatch uncertainty, and typed cleanup outcomes. Rollback affects only sessions whose creation was proven by returned core handles. See "load" in LibTmux::Workspace and LibTmux::X.

Members15#

Common operations3#

  • cause method For Load exceptions, return the original core or orchestration failure object.
  • report method For Load exceptions, return the partial-load report. It contains created IDs, completed and failed steps, dispatch uncertainty, and cleanup failures. Each cleanup_errors entry contains target (the captured identity), action (kill_session), and error (the original exception). Entries follow rollback attempt order, reversing creation order. An empty array means no cleanup failure was observed. The primary "cause" and secondary exception objects retain their identity. Inspect their dispatched and result fields without parsing prose. No I/O occurs.
  • report_data method For Load exceptions, return a detached, JSON-safe report hashref. The primary cause and each cleanup error become records with class, message, known path, and dispatched (null means unknown). Core creation/load causes retain their cause chain; a repeated exception is marked cycle. Process results retain exit code, signal, raw wait status, and bounded stdout and stderr as stdout_base64 and stderr_base64 using MIME::Base64. This diagnostic encoding does not serialize entity graphs or arbitrary exception internals. Other exceptions retain their class and string message. No I/O occurs; editing the export cannot change "report" or "cause".

Other members12#

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

Type to search.

Reference previewOpen reference