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

class LocalJumpError + StandardError + Exception

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

要約

ある Proc オブジェクトの作成元スコープがすでに終了しているとき、 その Proc オブジェクト内で return, break, retry のいずれかを実行すると発生します。

Proc の例を参照してください。

new(error_message = nil) -> Exception

exception(error_message = nil) -> Exception

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

[PARAM] error_message:

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

self == other -> bool

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

[PARAM] other:

自身と比較したいオブジェクトを指定します。

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

exit_value -> object

例外 LocalJumpError を発生する原因となった break や return に渡した値を返します。

例:

def foo
  proc { return 10 }
end

begin
  foo.call
rescue LocalJumpError => err
  p err              # => #<LocalJumpError: return from block-closure>
  p err.reason       # => :return
  p err.exit_value   # => 10
end

begin
  Block.new { break 5 }.call
rescue LocalJumpError => err
  p err              # => #<LocalJumpError: break from block-closure>
  p err.reason       # => :break
  p err.exit_value   # => 5
end

message -> String

to_s -> String

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

begin
  1 + nil
rescue => e
  p e.message   #=>  "nil can't be coerced into Fixnum"
end

reason -> Symbol

例外を発生させた原因をシンボルで返します。

返す値は以下のいずれかです。

• :break
• :redo
• :retry
• :next
• :return

例:

def foo
  proc { return 10 }
end

begin
  foo.call
rescue LocalJumpError => err
  p err              # => #<LocalJumpError: return from block-closure>
  p err.reason       # => :return
  p err.exit_value   # => 10
end

begin
  Block.new { break 5 }.call
rescue LocalJumpError => err
  p err              # => #<LocalJumpError: break from block-closure>
  p err.reason       # => :break
  p err.exit_value   # => 5
end

set_backtrace(errinfo) -> nil | String | [String]

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

[PARAM] errinfo:

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