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

function libtmux-erlang latest

tmux_error:format_error/2

Return supplemental native error text, or an empty map for an unknown reason.

Source and package
Qualified name
tmux_error:format_error/2
Declared in
tmux_error
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_error.erl
format_error/2 -spec format_error(term(), erlang:stacktrace()) -> #{general => unicode:chardata()}.

Description#

This is the erl_error:format_error/2 callback. It neither changes the exception nor catches it on behalf of a caller.

Examples#

1> #{general := Text} = tmux_error:format_error({bad_query_limit, -1}, []), ok.
ok
2> unicode:characters_to_binary(Text).
<<"The query limit must be an integer from 0 through 65536.">>
Esc

Type to search.

Reference previewOpen reference