Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

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

Erlang API

module libtmux-erlang latest

tmux_error

Explain library exceptions through Erlang's native error formatter.

Source and package
Qualified name
tmux_error
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_error.erl

Description#

The shell and erl_error:format_exception/3 call format_error/2 through EEP-54 stack metadata. Explanations supplement the original exception reason; tagged results from tmux_filter:new/2 and tmux_select:try_where/2 retain their existing structured data. Formatting performs no tmux I/O.

Only library-raised errors carry this metadata. Application callback failures retain their original class, reason and stack. Coverage errors describe missing observations; formatting never loads those observations or retries an action. Long detail values may be abbreviated in the explanation. The exception reason retains the original error data. See runtime diagnostics for the separate, bounded Logger report contract.

Members1#

  • format_error/2 function Return supplemental native error text, or an empty map for an unknown reason.

Guides#

Pages that discuss tmux_error.

Topics
Esc

Type to search.

Reference previewOpen reference