【Ruby3.x】Exception::full_message()メソッドの使い方
full_messageメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
full_messageメソッドは、Rubyプログラムの実行中に発生した例外（エラー）に関する詳細な情報を、整形された一つの文字列として取得するために使用するメソッドです。このメソッドは、エラーメッセージだけでなく、エラーが発生するまでのプログラムの呼び出し履歴（バックトレース）も含めて表示し、システムエンジニアがデバッグ作業を行う際に非常に役立ちます。
具体的には、例外オブジェクトに対してこのメソッドを呼び出すことで、人間が読みやすい形式でエラーレポートを生成します。引数として、表示形式を調整するためのオプションを指定できます。
highlight引数にtrue（真）を渡すと、エラーの種類やメッセージ部分が強調表示され、視覚的に重要な情報がすぐに認識できるようになります。この強調表示のデフォルト設定は、RUBY_FULL_MESSAGE_HIGHLIGHTという環境変数の値によって自動的に決まります。
order引数では、バックトレースの表示順序を制御します。:topを指定すると最新の呼び出しがリストの上部に表示され、:bottomを指定すると一番古い呼び出しが上部に表示されます。デフォルトでは:topが設定されています。
また、count引数には、表示するバックトレースの行数を数値で指定できます。この引数を省略するかnil（ヌル）を設定した場合は、すべての呼び出し履歴が表示されます。
これらの引数を活用することで、開発者はエラーログの出力内容を柔軟に調整し、効率的にエラーの原因を特定し、問題を解決することができます。
構文(syntax)
1begin 2 # 例外を発生させる処理の例 3 raise ArgumentError, "不正な引数が指定されました" 4rescue => e 5 # 例外オブジェクト e に対して full_message メソッドを呼び出す構文 6 puts e.full_message 7end
引数(parameters)
options = nil
- options = nil: メッセージのフォーマットをカスタマイズするためのオプションを指定するハッシュ、またはnil
戻り値(return)
String
発生した例外情報を、メッセージ、クラス名、バックトレースを含んだ整形済みの文字列として返します。