Exception#detailed_message

(?highlight: bool?, **untyped ignored) -> ::String

detailed_message(highlight: false, **kwargs) → string

static VALUE
exc_detailed_message(int argc, VALUE *argv, VALUE exc)
{
    VALUE opt;

    rb_scan_args(argc, argv, "0:", &opt);

    VALUE highlight = check_highlight_keyword(opt, 0);

    extern VALUE rb_decorate_message(const VALUE eclass, VALUE emesg, int highlight);

    return rb_decorate_message(CLASS_OF(exc), rb_get_message(exc), RTEST(highlight));
}

Returns the message string with enhancements:

Includes the exception class name in the first line.
If the value of keyword highlight is true, includes bolding and underlining ANSI codes (see below) to enhance the appearance of the message.

Examples:

Example

begin
  1 / 0
rescue => x
  p x.message
  p x.detailed_message                  # Class name added.
  p x.detailed_message(highlight: true) # Class name, bolding, and underlining added.
end

Output:

Example

"divided by 0"
"divided by 0 (ZeroDivisionError)"
"\e[1mdivided by 0 (\e[1;4mZeroDivisionError\e[m\e[1m)\e[m"

This method is overridden by some gems in the Ruby standard library to add information:

An overriding method must be tolerant of passed keyword arguments, which may include (but may not be limited to):

:highlight.
:did_you_mean.
:error_highlight.
:syntax_suggest.

An overriding method should also be careful with ANSI code enhancements; see Messages.

Ruby version changes

3.2
- Exception#detailed_message has been added. The default error printer calls this method on the Exception object instead of message. [Feature #18564]

See also #cause #exception #backtrace_locations #full_message also in 4.1 · 4.0 · 3.3 · 3.2

‹ prev#cause next ›#exception