Ruby 2.4.0 リファレンスマニュアル > ライブラリ一覧 > 組み込みライブラリ > Exceptionクラス

class Exception

クラスの継承リスト: Exception < Object < Kernel < BasicObject

要約

全ての例外の祖先のクラスです。

目次

特異メソッド
exception new
インスタンスメソッド
== backtrace backtrace_locations cause exception inspect message to_s set_backtrace

特異メソッド

new(error_message = nil) -> Exception[permalink][rdoc]
exception(error_message = nil) -> Exception

例外オブジェクトを生成して返します。

[PARAM] error_message:
エラーメッセージを表す文字列を指定します。このメッセージは 属性 Exception#message の値になり、デフォルトの例外ハンドラで表示されます。

インスタンスメソッド

self == other -> bool[permalink][rdoc]

自身と指定された other のクラスが同じであり、 message と backtrace が == メソッドで比較して 等しい場合に true を返します。そうでない場合に false を返します。

[PARAM] other:
自身と比較したいオブジェクトを指定します。 自身と異なるクラスのオブジェクトを指定した場合は Exception#exception を実行して変換を試みます。
backtrace -> [String][permalink][rdoc]

バックトレース情報を返します。

デフォルトでは

という形式の String の配列です。

def methd
  raise
end

begin
  methd
rescue => e
  p e.backtrace
end

#=> ["filename.rb:2:in `methd'", "filename.rb:6"]

[SEE_ALSO] Exception#backtrace_locations

backtrace_locations -> [Thread::Backtrace::Location][permalink][rdoc]

バックトレース情報を返します。Exception#backtraceに似ていますが、 Thread::Backtrace::Location の配列を返す点が異なります。

現状では Exception#set_backtrace によって戻り値が変化する事はあり ません。

[SEE_ALSO] Exception#backtrace

cause -> Exception | nil[permalink][rdoc]

self の前の例外(self が rescue 節や ensure 節の中で発生した例外の場合、 その前に発生していた元々の例外)を返します。存在しない場合は nil を返し ます。

exception -> self[permalink][rdoc]
exception(error_message) -> Exception

引数を指定しない場合は self を返します。引数を指定した場合 自身のコピー を生成し Exception#message 属性を error_message にして返します。

Kernel.#raise は、実質的に、例外オブジェクトの exception メソッドの呼び出しです。

[PARAM] error_message:
エラーメッセージを表す文字列を指定します。
begin
 ...        # 何か処理
rescue => e
 raise e.exception("an error occurs during hogehoge process")  # 詳しいエラーメッセージ
end
inspect -> String[permalink][rdoc]

self のクラス名と message を文字列にして返します。

message -> String[permalink][rdoc]
to_s -> String

エラーメッセージをあらわす文字列を返します。

begin
  1 + nil
rescue => e
  p e.message   #=>  "nil can't be coerced into Fixnum"
end
set_backtrace(errinfo) -> nil | String | [String][permalink][rdoc]

バックトレース情報に errinfo を設定し、設定されたバックトレース 情報を返します。

[PARAM] errinfo:
nil、String あるいは String の配列のいずれかを指定します。