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

class Errno::EXXX + SystemCallError + StandardError + Exception

クラスの継承リスト: Errno::EXXX < SystemCallError < StandardError < Exception < Object < Kernel < BasicObject

要約

システム依存のエラーコードのそれぞれに対応する一連の例外クラスです。 Rubyのライブラリ内部でシステムコールや一部のC言語関数が失敗したときに発生します。

実際には「EXXX」というクラスが定義されているわけではありません。「XXX」の部分は下記に列挙したような各種のエラー名が入ります。 例えば、File.open の内部でシステムコール open(2) がエラーコード ENOENT を返すと、Rubyは例外 Errno::ENOENT を発生させます。

Ruby は処理系がコンパイルされるときに、デフォルトで下記リストのような Errno::EXXX クラスを定義しようとします。 動作環境に EXXX というエラーコードが存在しない場合、Rubyはその Errno::EXXX を Errno::NOERROR の別名として定義します。

また、以下の一覧にはないシステムエラーが発生した場合は、 Errno::EXXX (XXX はエラー番号を表す 3 桁の数字) という名前の例外クラスが自動的に作成され、発生します。 (これは Ruby 内部でのみ行われ、 Ruby プログラム上で SystemCallError.new に一覧にないコードを渡してもクラスは作成されません)

それぞれの例外が発生し得るケースについては、この項では記述しません。 例外を発生する各メソッドのマニュアルおよびオペレーティングシステムのマニュアルを参照してください。

エラー名リスト

個々の例外の意味はシステム依存です。 システムのマニュアル errno(3) を参照してください。 Microsoft Windows システムにおいては http://msdn2.microsoft.com/ja-jp/library/5814770t.aspx を参照してください。

特異メソッド

self === other -> bool

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 = nil) -> Exception
exception(error_message = nil) -> Exception

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

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

Errno::EXXX オブジェクトを生成して返します。

[PARAM] error_message:
エラーメッセージを表す文字列 
p Errno::ENOENT
    # => #<Errno::ENOENT: No such file or directory>
p Errno::ENOENT('message')
    # => #<Errno::ENOENT: No such file or directory - message>
new(error_message) -> SystemCallError

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

[PARAM] error_message:
エラーメッセージを表す文字列

例: 

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

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

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

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

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

[PARAM] error_message:
エラーメッセージを表す文字列
[PARAM] errno:
システム依存のエラーコード
[EXCEPTION] TypeError:
errno を整数に変換できないときに発生します。
[EXCEPTION] RangeError:
errno が Fixnum で表せる範囲を超えるときに発生します。

例: 

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>

インスタンスメソッド

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"]
errno -> Fixnum | nil

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

エラーコードを渡さない形式で生成した場合は 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 定数を使います。

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

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

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

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

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

定数

Errno -> Fixnum

Errno::EXXX の各クラスに対応するシステム依存のエラーコード値(整数)です。

例: 

p Errno::EAGAIN::Errno            # => 11
p Errno::EWOULDBLOCK::Errno       # => 11
class Errno::EXXX