instance method Exception#full_message

例外の整形された文字列を返します。

返される文字列は Ruby が捕捉されなかった例外を標準エラー出力に出力するときと同じ形式です。そのため、メソッド呼び出し時に $stderr が変更されておらず、$stderr.tty? が真の場合はエスケープシーケンスによる文字装飾がついています。

[注意] このメソッドは実験的な機能として提供されています。仕様が変更になる可能性があります。そして実際に、キーワード引数 highlight と order は 2.5.1 で追加されました。

[PARAM] highlight:

エスケープシーケンスによる文字装飾をつけるかどうかを指定します。デフォルト値は Exception.to_tty? の返り値と同じです。

[PARAM] order:

:top か :bottom で指定する必要があります。バックトレースの一番奥がエラーメッセージの上(top)か下(bottom)かを指定します。デフォルト値は Exception.to_tty? が真なら :bottom で偽なら :top です。

例

begin
  raise "test"
rescue => e
  p e.full_message   # => "\e[1mTraceback \e[m(most recent call last):\ntest.rb:2:in `<main>': \e[1mtest (\e[4;1mRuntimeError\e[m\e[1m)\n\e[m"
  $stderr = $stdout
  p e.full_message   # => "test.rb:2:in `<main>': test (RuntimeError)\n"
  $stderr = STDERR
  p e.full_message   # => "\e[1mTraceback \e[m(most recent call last):\ntest.rb:2:in `<main>': \e[1mtest (\e[4;1mRuntimeError\e[m\e[1m)\n\e[m"
end

[SEE_ALSO] Exception.to_tty?