class Timeout::Error + Interrupt + SignalException + Exception
クラスの継承リスト: Timeout::Error < Interrupt < SignalException < Exception < Object < Kernel
aliases: TimeoutError
要約
timeout で定義される例外クラスです。 関数 timeout がタイムアウトすると発生します。
timeout を使うライブラリを作成する場合は、ユーザが指定した timeout を捕捉しないようにライブラリ内で TimeoutError のサブクラスを 定義して使用した方が無難です。
==> foo.rb <== require 'timeout.rb' class Foo FooTimeoutError = Class.new(TimeoutError) def longlongtime_method timeout(100, FooTimeoutError) { ... } end end ==> main.rb <== require 'foo' timeout(5) { Foo.new.longlongtime_method }
特異メソッド
new(error_message = nil) -> Exception
exception(error_message = nil) -> Exception
-
例外オブジェクトを生成して返します。
- [PARAM] error_message:
- エラーメッセージを表す文字列を指定します。このメッセージは 属性 Exception#message の値になり、デフォルトの例外ハンドラで表示されます。
インスタンスメソッド
backtrace -> [String]
-
バックトレース情報を返します。
デフォルトでは
- "#{sourcefile}:#{sourceline}:in `#{method}'" (メソッド内の場合)
- "#{sourcefile}:#{sourceline}" (トップレベルの場合)
という形式の String の配列です。
def methd raise end begin methd rescue => e p e.backtrace end #=> ["filename.rb:2:in `methd'", "filename.rb:6"]
exception -> self
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
message -> String
to_s -> String
to_str -> String
-
エラーメッセージをあらわす文字列を返します。
begin 1 + nil rescue => e p e.message #=> "nil can't be coerced into Fixnum" end
set_backtrace(errinfo) -> nil | String | [String]
-
バックトレース情報に errinfo を設定し、設定されたバックトレース 情報を返します。
class Timeout::Error