class SystemCallError

要約

Ruby の実装に用いられているシステムコールまたは一部の C 言語関数が失敗した時に発生する例外です。システムコールの失敗した原因を表すエラーコードを保持します。

多くの場合、実際には SystemCallError そのものではなくサブクラスである Errno::EXXX (XXX はエラーコードの値によって異なる。システム定義のエラー名と同じ名前) が発生します。詳しくは Errno::EXXX を参照してください。

目次

特異メソッド

• ===
• new

インスタンスメソッド

• errno

継承しているメソッド

Exceptionから継承しているメソッド

• ==
• backtrace
• backtrace_locations
• cause
• exception
• full_message
• inspect
• message
• set_backtrace
• to_s

特異メソッド

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

other が SystemCallError のサブクラスのインスタンスで、かつ、other.errno の値が self::Errno と同じ場合に真を返します。そうでない場合は偽を返します。

従って、特に other が self.kind_of?(other) である場合には Module#=== と同様に真を返します。その他に、 Errno::EXXX::Errno == Errno::EYYY::Errno である場合にも Errno::EXXX == Errno::EYYY.new は真を返します。

エラー名は異なるがエラーコードは同じであるような Errno::EXXX 例外をまとめて捕捉するために Module#=== を上書きしていました。しかし、Ruby 1.8 のリリース時点では同じ errno 値を持つクラスは一つしか作られないようになりました。そのため現在はこのメソッドは実質上 Module#=== と同じ意味しかありません。

[PARAM] other:

任意のオブジェクト

例

p Errno::EAGAIN::Errno
p Errno::EWOULDBLOCK::Errno
begin
  raise Errno::EAGAIN, "pseudo error"
rescue Errno::EWOULDBLOCK
  p $!
end

# => 11
     11
     #<Errno::EAGAIN: pseudo error>

new(error_message) -> SystemCallError[permalink][rdoc][edit]

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

[PARAM] error_message:

エラーメッセージを表す文字列

例:

p SystemCallError.new("message")
    # => #<SystemCallError: unknown error - message>

new(error_message, errno) -> SystemCallError[permalink][rdoc][edit]

new(errno) -> SystemCallError

整数 errno に対応する Errno::EXXX オブジェクトを生成して返します。

整数 errno をシステムコールで発生したエラーの原因を示すコードであると解釈し、対応する例外クラスのインスタンスを生成して返します。

生成されるオブジェクトは SystemCallError の直接のインスタンスではなく、サブクラスのインスタンスです。それらのサブクラスは Errno モジュール内に定義されています。対応するサブクラスが存在しないコードを与えた場合には、 SystemCallError の直接のインスタンスが生成されます。

エラーコードの取り得る値および意味はシステムに依存します。詳しくは Errno::EXXX を参照してください。

[PARAM] error_message:

エラーメッセージを表す文字列

[PARAM] errno:

システム依存のエラーコード

[EXCEPTION] TypeError:

errno を整数に変換できないときに発生します。

例:

p SystemCallError.new("message", 2)
    # => #<Errno::ENOENT: No such file or directory - message>
p SystemCallError.new(2)
    # => #<Errno::ENOENT: No such file or directory>
p SystemCallError.new(256)
    # => #<SystemCallError: Unknown error 256>

インスタンスメソッド

errno -> Integer | nil[permalink][rdoc][edit]

レシーバに対応するシステム依存のエラーコードを返します。

エラーコードを渡さない形式で生成した場合は nil を返します。

begin
  raise Errno::ENOENT
rescue Errno::ENOENT => err
  p err.errno                 # => 2
  p Errno::ENOENT::Errno      # => 2
end

begin
  raise SystemCallError, 'message'
rescue SystemCallError => err
  p err.errno                 # => nil
end

なお、例外を発生させずにエラーコードを得るには、 Errno::EXXX::Errno 定数を使います。