検索結果

Dir.chroot(path) -> 0 (22.0)

• 2.2.0

• 特異メソッド

ルートディレクトリを path に変更します。

ルートディレクトリを path に変更します。

スーパーユーザだけがルートディレクトリを変更できます。
ルートディレクトリの変更に成功すれば 0 を返します。
各プラットフォームのマニュアルの chroot の項も参照して下さい。

@param path ディレクトリのパスを文字列で指定します。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
p Dir.glob("*") #=> ["file1", "file2]
Dir.chroot("./")
p Dir.glob("/*") #=> ["/file1", "/fi...

• Dir

Dir.delete(path) -> 0 (22.0)

• 2.2.0

• 特異メソッド

ディレクトリを削除します。ディレクトリは空でなければいけませ ん。ディレクトリの削除に成功すれば 0 を返します。

ディレクトリを削除します。ディレクトリは空でなければいけませ
ん。ディレクトリの削除に成功すれば 0 を返します。

@param path ディレクトリのパスを文字列で指定します。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
Dir.delete("/tmp/hoge-jbrYBh.tmp")
//}

• Dir

Dir.entries(path) -> [String] (22.0)

• 2.2.0

• 特異メソッド

ディレクトリ path に含まれるファイルエントリ名の 配列を返します。

ディレクトリ path に含まれるファイルエントリ名の
配列を返します。

@param path ディレクトリのパスを文字列で指定します。

@param encoding ディレクトリのエンコーディングを文字列か
Encoding オブジェクトで指定します。省略した場合は
ファイルシステムのエンコーディングと同じになります。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
Dir.entries('.') #=> [".", "..", "bar", "foo"]
...

• Dir

Dir.entries(path, encoding: Encoding.find("filesystem")) -> [String] (22.0)

• 2.2.0

• 特異メソッド

ディレクトリ path に含まれるファイルエントリ名の 配列を返します。

ディレクトリ path に含まれるファイルエントリ名の
配列を返します。

@param path ディレクトリのパスを文字列で指定します。

@param encoding ディレクトリのエンコーディングを文字列か
Encoding オブジェクトで指定します。省略した場合は
ファイルシステムのエンコーディングと同じになります。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
Dir.entries('.') #=> [".", "..", "bar", "foo"]
...

• Dir

Dir.exist?(file_name) -> bool (22.0)

• 2.2.0

• 特異メソッド

file_name で与えられたディレクトリが存在する場合に真を返します。 そうでない場合は、偽を返します。

file_name で与えられたディレクトリが存在する場合に真を返します。
そうでない場合は、偽を返します。

@param file_name 存在を確認したいディレクトリ名。

//emlist[例][ruby]{
Dir.exist?(".") # => true
File.directory?(".") # => true
//}

@see File.directory?

• Dir

絞り込み条件を変える

Dir.foreach(path) -> Enumerator (22.0)

• 2.2.0

• 特異メソッド

ディレクトリ path の各エントリを表す文字列を引数として、ブロックを評価します。

ディレクトリ path の各エントリを表す文字列を引数として、ブロックを評価します。

ブロックが与えられなかった場合、各エントリを文字列として保持する
Enumerator オブジェクトを返します。

@param path ディレクトリのパスを文字列で指定します。

@param encoding ディレクトリのエンコーディングを文字列か
Encoding オブジェクトで指定します。省略した場合は
ファイルシステムのエンコーディングと同じになります。

@raise Errno::EXXX 失敗した場合に発生します。

//...

• Dir
• Enumerator

Dir.foreach(path) {|file| ...} -> nil (22.0)

• 2.2.0

• 特異メソッド

ディレクトリ path の各エントリを表す文字列を引数として、ブロックを評価します。

ディレクトリ path の各エントリを表す文字列を引数として、ブロックを評価します。

ブロックが与えられなかった場合、各エントリを文字列として保持する
Enumerator オブジェクトを返します。

@param path ディレクトリのパスを文字列で指定します。

@param encoding ディレクトリのエンコーディングを文字列か
Encoding オブジェクトで指定します。省略した場合は
ファイルシステムのエンコーディングと同じになります。

@raise Errno::EXXX 失敗した場合に発生します。

//...

• Dir
• Enumerator

Dir.foreach(path, encoding: Encoding.find("filesystem")) -> Enumerator (22.0)

• 2.2.0

• 特異メソッド

ディレクトリ path の各エントリを表す文字列を引数として、ブロックを評価します。

ディレクトリ path の各エントリを表す文字列を引数として、ブロックを評価します。

ブロックが与えられなかった場合、各エントリを文字列として保持する
Enumerator オブジェクトを返します。

@param path ディレクトリのパスを文字列で指定します。

@param encoding ディレクトリのエンコーディングを文字列か
Encoding オブジェクトで指定します。省略した場合は
ファイルシステムのエンコーディングと同じになります。

@raise Errno::EXXX 失敗した場合に発生します。

//...

• Dir
• Enumerator

Dir.foreach(path, encoding: Encoding.find("filesystem")) {|file| ...} -> nil (22.0)

• 2.2.0

• 特異メソッド

ディレクトリ path の各エントリを表す文字列を引数として、ブロックを評価します。

ディレクトリ path の各エントリを表す文字列を引数として、ブロックを評価します。

ブロックが与えられなかった場合、各エントリを文字列として保持する
Enumerator オブジェクトを返します。

@param path ディレクトリのパスを文字列で指定します。

@param encoding ディレクトリのエンコーディングを文字列か
Encoding オブジェクトで指定します。省略した場合は
ファイルシステムのエンコーディングと同じになります。

@raise Errno::EXXX 失敗した場合に発生します。

//...

• Dir
• Enumerator

Dir.getwd -> String (22.0)

• 2.2.0

• 特異メソッド

カレントディレクトリのフルパスを文字列で返します。

カレントディレクトリのフルパスを文字列で返します。

@raise Errno::EXXX カレントディレクトリの取得に失敗した場合に発生します(が、普通は失敗することはありません)。

//emlist[例][ruby]{
Dir.chdir("/tmp") #=> 0
Dir.getwd #=> "/tmp"
//}

• Dir

絞り込み条件を変える

Dir.home -> String | nil (22.0)

• 2.2.0

• 特異メソッド

現在のユーザまたは指定されたユーザのホームディレクトリを返します。

現在のユーザまたは指定されたユーザのホームディレクトリを返します。

Dir.home や Dir.home("root") は
File.expand_path("~") や File.expand_path("~root") と
ほぼ同じです。

//emlist[例][ruby]{
Dir.home # => "/home/vagrant"
Dir.home("root") # => "/root"
//}

@see File.expand_path

• Dir

Dir.home(user) -> String | nil (22.0)

• 2.2.0

• 特異メソッド

現在のユーザまたは指定されたユーザのホームディレクトリを返します。

現在のユーザまたは指定されたユーザのホームディレクトリを返します。

Dir.home や Dir.home("root") は
File.expand_path("~") や File.expand_path("~root") と
ほぼ同じです。

//emlist[例][ruby]{
Dir.home # => "/home/vagrant"
Dir.home("root") # => "/root"
//}

@see File.expand_path

• Dir

Dir.mkdir(path, mode = 0777) -> 0 (22.0)

• 2.2.0

• 特異メソッド

path で指定された新しいディレクトリを作ります。パーミッションは mode で指定された値に umask をかけた値 (mode & ~umask) になります。 mkdir(2) も参照して下さい。 ディレクトリの作成に成功すれば 0 を返します。

path で指定された新しいディレクトリを作ります。パーミッションは
mode で指定された値に umask をかけた値 (mode & ~umask) になります。
mkdir(2) も参照して下さい。
ディレクトリの作成に成功すれば 0 を返します。

@param path ディレクトリのパスを文字列で指定します。

@param mode ディレクトリのモードを整数で与えます。

@raise Errno::EXXX ディレクトリの作成に失敗した場合に発生します。

//emlist[例][ruby]{
p File.umask ...

• Dir

Dir.pwd -> String (22.0)

• 2.2.0

• 特異メソッド

カレントディレクトリのフルパスを文字列で返します。

カレントディレクトリのフルパスを文字列で返します。

@raise Errno::EXXX カレントディレクトリの取得に失敗した場合に発生します(が、普通は失敗することはありません)。

//emlist[例][ruby]{
Dir.chdir("/tmp") #=> 0
Dir.getwd #=> "/tmp"
//}

• Dir

Dir.rmdir(path) -> 0 (22.0)

• 2.2.0

• 特異メソッド

ディレクトリを削除します。ディレクトリは空でなければいけませ ん。ディレクトリの削除に成功すれば 0 を返します。

ディレクトリを削除します。ディレクトリは空でなければいけませ
ん。ディレクトリの削除に成功すれば 0 を返します。

@param path ディレクトリのパスを文字列で指定します。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
Dir.delete("/tmp/hoge-jbrYBh.tmp")
//}

• Dir

絞り込み条件を変える

Dir.unlink(path) -> 0 (22.0)

• 2.2.0

• 特異メソッド

ディレクトリを削除します。ディレクトリは空でなければいけませ ん。ディレクトリの削除に成功すれば 0 を返します。

ディレクトリを削除します。ディレクトリは空でなければいけませ
ん。ディレクトリの削除に成功すれば 0 を返します。

@param path ディレクトリのパスを文字列で指定します。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
Dir.delete("/tmp/hoge-jbrYBh.tmp")
//}

• Dir

ENV.[](key) -> String (22.0)

• 2.2.0

• 特異メソッド

key に対応する環境変数の値を返します。該当する環境変数が存在 しない時には nil を返します。

key に対応する環境変数の値を返します。該当する環境変数が存在
しない時には nil を返します。

@param key 環境変数名を指定します。文字列で指定します。文字列以外のオブ
ジェクトを指定した場合は to_str メソッドによる暗黙の型変換
を試みます。

//emlist[][ruby]{
ENV['PATH'] # => "/usr/local/bin:/usr/bin:/bin:/usr/X11/bin"
ENV['NON_EXIST_KEY'] # => nil
//}

• ENV

ENV.[]=(key, value) (22.0)

• 2.2.0

• 特異メソッド

key に対応する環境変数の値を value にします。 value が nil の時、key に対応する環境変数を取り除きます。

key に対応する環境変数の値を value にします。
value が nil の時、key に対応する環境変数を取り除きます。

@param key 環境変数名を指定します。文字列で指定します。文字列以外のオ
ブジェクトを指定した場合は to_str メソッドによる暗黙の型変
換を試みます。
@param value 置き換えるべき値を指定します。文字列で指定します。文字列以
外のオブジェクトを指定した場合は to_str メソッドによる暗黙
の型変換を試みます。

@retur...

• ENV

ENV.clear -> self (22.0)

• 2.2.0

• 特異メソッド

環境変数をすべてクリアします。self を返します。

環境変数をすべてクリアします。self を返します。

//emlist[][ruby]{
ENV.clear
p ENV # => {}
//}

• ENV

ENV.clone(freeze: true) -> object (22.0)

• 2.2.0

• 特異メソッド

ENV オブジェクトの複製を作成して返します。

ENV オブジェクトの複製を作成して返します。

ENV は OS のプロセス全体で共有される環境変数を操作するラッパーオブジェクトなので、複製は有用ではありません。
そのため、3.1 からは複製で環境変数を操作するときに deprecated 警告がでます。

テスト実行中に環境変数を退避する用途には ENV.to_h を使用してください。

//emlist[][ruby]{
saved_env = ENV.to_h
# (テストなど)
ENV.replace(saved_env)
//}

@see Object#clone

• ENV

絞り込み条件を変える

ENV.delete(key) -> String | nil (22.0)

• 2.2.0

• 特異メソッド

key に対応する環境変数を取り除きます。取り除かれた環境変数の 値を返しますが、key に対応する環境変数が存在しない時には nil を返します。

key に対応する環境変数を取り除きます。取り除かれた環境変数の
値を返しますが、key に対応する環境変数が存在しない時には
nil を返します。

ブロックが与えられた時には key にマッチするものがなかった時
に評価されます。

@param key 環境変数名を指定します。文字列で指定します。文字列で指定しま
す。文字列以外のオブジェクトを指定した場合は to_str メソッド
による暗黙の型変換を試みます。

//emlist[][ruby]{
ENV['TEST'] = 'foo'
ENV.delete('TEST') # => "...

• ENV

ENV.delete(key) {|key| ... } -> String | nil (22.0)

• 2.2.0

• 特異メソッド

key に対応する環境変数を取り除きます。取り除かれた環境変数の 値を返しますが、key に対応する環境変数が存在しない時には nil を返します。

key に対応する環境変数を取り除きます。取り除かれた環境変数の
値を返しますが、key に対応する環境変数が存在しない時には
nil を返します。

ブロックが与えられた時には key にマッチするものがなかった時
に評価されます。

@param key 環境変数名を指定します。文字列で指定します。文字列で指定しま
す。文字列以外のオブジェクトを指定した場合は to_str メソッド
による暗黙の型変換を試みます。

//emlist[][ruby]{
ENV['TEST'] = 'foo'
ENV.delete('TEST') # => "...

• ENV

ENV.delete_if -> Enumerator (22.0)

• 2.2.0

• 特異メソッド

key と value を引数としてブロックを評価した値が真であ る時、環境変数を削除します。

key と value を引数としてブロックを評価した値が真であ
る時、環境変数を削除します。

reject! は要素に変化がなければ nil を返します。

//emlist[][ruby]{
ENV['FOO'] = 'bar'
ENV.delete_if { |key, value| key == 'FOO' && value == 'bar' } # => ENV
ENV.reject! { |key, value| key == 'FOO' && value == 'bar' } # => nil
//}

• ENV

ENV.delete_if {|key, value| ... } -> ENV (22.0)

• 2.2.0

• 特異メソッド

key と value を引数としてブロックを評価した値が真であ る時、環境変数を削除します。

key と value を引数としてブロックを評価した値が真であ
る時、環境変数を削除します。

reject! は要素に変化がなければ nil を返します。

//emlist[][ruby]{
ENV['FOO'] = 'bar'
ENV.delete_if { |key, value| key == 'FOO' && value == 'bar' } # => ENV
ENV.reject! { |key, value| key == 'FOO' && value == 'bar' } # => nil
//}

• ENV

ENV.each -> Enumerator (22.0)

• 2.2.0

• 特異メソッド

key と value を引数としてブロックを評価します。

key と value を引数としてブロックを評価します。

//emlist[][ruby]{
ENV['FOO'] = 'bar'
ENV.each do |key, value|
p "value is #{value}" if key == 'FOO' # => "value is bar"
end
# => ENV
//}

• ENV

絞り込み条件を変える

ENV.each {|key, value| ... } -> self (22.0)

• 2.2.0

• 特異メソッド

key と value を引数としてブロックを評価します。

key と value を引数としてブロックを評価します。

//emlist[][ruby]{
ENV['FOO'] = 'bar'
ENV.each do |key, value|
p "value is #{value}" if key == 'FOO' # => "value is bar"
end
# => ENV
//}

• ENV

ENV.each_key -> Enumerator (22.0)

• 2.2.0

• 特異メソッド

key を引数としてブロックを評価します。

key を引数としてブロックを評価します。

//emlist[][ruby]{
ENV['FOO'] = 'bar'
ENV.each_key do |key|
p "key #{key} detected" if key == 'FOO'
end
# "key FOO detected"
//}

• ENV

ENV.each_key {|key| ... } -> self (22.0)

• 2.2.0

• 特異メソッド

key を引数としてブロックを評価します。

key を引数としてブロックを評価します。

//emlist[][ruby]{
ENV['FOO'] = 'bar'
ENV.each_key do |key|
p "key #{key} detected" if key == 'FOO'
end
# "key FOO detected"
//}

• ENV

ENV.each_pair -> Enumerator (22.0)

• 2.2.0

• 特異メソッド

key と value を引数としてブロックを評価します。

key と value を引数としてブロックを評価します。

//emlist[][ruby]{
ENV['FOO'] = 'bar'
ENV.each do |key, value|
p "value is #{value}" if key == 'FOO' # => "value is bar"
end
# => ENV
//}

• ENV

ENV.each_pair {|key, value| ... } -> self (22.0)

• 2.2.0

• 特異メソッド

key と value を引数としてブロックを評価します。

key と value を引数としてブロックを評価します。

//emlist[][ruby]{
ENV['FOO'] = 'bar'
ENV.each do |key, value|
p "value is #{value}" if key == 'FOO' # => "value is bar"
end
# => ENV
//}

• ENV

絞り込み条件を変える

ENV.reject -> Enumerator (22.0)

• 2.2.0

• 特異メソッド

環境変数のうち、ブロックを評価した値が真であるものをとり除きます。 Enumerable#reject と異なり Hash を返します。また、とり除いた結果 は実際の環境変数に影響を与えません。

環境変数のうち、ブロックを評価した値が真であるものをとり除きます。
Enumerable#reject と異なり Hash を返します。また、とり除いた結果
は実際の環境変数に影響を与えません。

//emlist[][ruby]{
ENV['TEST'] = 'foo'
result = ENV.reject { |key, value| key == 'TEST' }
result['TEST'] # => nil
ENV['TEST'] # => "foo"
//}

• ENV

ENV.reject {|key, value| ... } -> Hash (22.0)

• 2.2.0

• 特異メソッド

環境変数のうち、ブロックを評価した値が真であるものをとり除きます。 Enumerable#reject と異なり Hash を返します。また、とり除いた結果 は実際の環境変数に影響を与えません。

環境変数のうち、ブロックを評価した値が真であるものをとり除きます。
Enumerable#reject と異なり Hash を返します。また、とり除いた結果
は実際の環境変数に影響を与えません。

//emlist[][ruby]{
ENV['TEST'] = 'foo'
result = ENV.reject { |key, value| key == 'TEST' }
result['TEST'] # => nil
ENV['TEST'] # => "foo"
//}

• ENV

ENV.reject! -> Enumerator (22.0)

• 2.2.0

• 特異メソッド

key と value を引数としてブロックを評価した値が真であ る時、環境変数を削除します。

key と value を引数としてブロックを評価した値が真であ
る時、環境変数を削除します。

reject! は要素に変化がなければ nil を返します。

//emlist[][ruby]{
ENV['FOO'] = 'bar'
ENV.delete_if { |key, value| key == 'FOO' && value == 'bar' } # => ENV
ENV.reject! { |key, value| key == 'FOO' && value == 'bar' } # => nil
//}

• ENV

ENV.reject! {|key, value| ... } -> ENV | nil (22.0)

• 2.2.0

• 特異メソッド

key と value を引数としてブロックを評価した値が真であ る時、環境変数を削除します。

key と value を引数としてブロックを評価した値が真であ
る時、環境変数を削除します。

reject! は要素に変化がなければ nil を返します。

//emlist[][ruby]{
ENV['FOO'] = 'bar'
ENV.delete_if { |key, value| key == 'FOO' && value == 'bar' } # => ENV
ENV.reject! { |key, value| key == 'FOO' && value == 'bar' } # => nil
//}

• ENV

ENV.store(key, value) -> String (22.0)

• 2.2.0

• 特異メソッド

key に対応する環境変数の値を value にします。 value が nil の時、key に対応する環境変数を取り除きます。

key に対応する環境変数の値を value にします。
value が nil の時、key に対応する環境変数を取り除きます。

@param key 環境変数名を指定します。文字列で指定します。文字列以外のオ
ブジェクトを指定した場合は to_str メソッドによる暗黙の型変
換を試みます。
@param value 置き換えるべき値を指定します。文字列で指定します。文字列以
外のオブジェクトを指定した場合は to_str メソッドによる暗黙
の型変換を試みます。

@retur...

• ENV

絞り込み条件を変える

Encoding.aliases -> Hash (22.0)

• 2.2.0

• 特異メソッド

エンコーディングの別名に対して元の名前を対応づけるハッシュを返します。

エンコーディングの別名に対して元の名前を対応づけるハッシュを返します。

//emlist[例][ruby]{
p Encoding.aliases
#=> {"BINARY"=>"ASCII-8BIT", "ASCII"=>"US-ASCII", "ANSI_X3.4-1968"=>"US-ASCII",
# "SJIS"=>"Windows-31J", "eucJP"=>"EUC-JP", "CP932"=>"Windows-31J"}
//}

• Encoding

Encoding.find(name) -> Encoding (22.0)

• 2.2.0

• 特異メソッド

指定された name という名前を持つ Encoding オブジェクトを返します。

指定された name という名前を持つ Encoding オブジェクトを返します。

@param name エンコーディング名を表す String を指定します。
@return 発見された Encoding オブジェクトを返します。
@raise ArgumentError 指定した名前のエンコーディングが発見できないと発生します。

特殊なエンコーディング名として、ロケールエンコーディングを表す locale、default_external を表す external、default_internal を表す internal、ファイルシステムエンコーディングを表す filesystem...

• Encoding
• String

Encoding.list -> [Encoding] (22.0)

• 2.2.0

• 特異メソッド

現在ロードされているエンコーディングのリストを返します。

現在ロードされているエンコーディングのリストを返します。

//emlist[例][ruby]{
Encoding.list
# => [#<Encoding:ASCII-8BIT>, #<Encoding:EUC-JP>,
# #<Encoding:Shift_JIS>, #<Encoding:UTF-8>,
# #<Encoding:ISO-2022-JP (dummy)>]

Encoding.find("US-ASCII")
# => #<Encoding:US-ASCII>

Encoding.list
# => [#<Encoding:ASCII-8BIT>, #<...

• Encoding

Encoding.name_list -> [String] (22.0)

• 2.2.0

• 特異メソッド

利用可能なエンコーディングの名前を文字列の配列で返します。

利用可能なエンコーディングの名前を文字列の配列で返します。

//emlist[例][ruby]{
p Encoding.name_list
#=> ["US-ASCII", "ASCII-8BIT", "UTF-8",
# "ISO-8859-1", "Shift_JIS", "EUC-JP",
# "Windows-31J",
# "BINARY", "CP932", "eucJP", ...]
//}

• Encoding

Encoding::Converter.asciicompat_encoding(encoding) -> Encoding | nil (22.0)

• 2.2.0

• 特異メソッド

同じ文字集合を持つ ASCII 互換エンコーディングを返します。

同じ文字集合を持つ ASCII 互換エンコーディングを返します。

@param string エンコーディング名
@param encoding エンコーディングオブジェクト
@return ASCII 互換エンコーディングのオブジェクトか nil

引数とエンコーディングと同じ文字集合を持つ ASCII 互換エンコーディングを返します。引数と戻り値、2 つのエンコーディング間では変換しても未定義文字の例外は発生しません。
引数が ASCII 互換エンコーディングである場合や、エンコーディングでない場合は nil を返します。

//emlist[][ruby]{
Encoding::Con...

• Encoding::Converter

絞り込み条件を変える

Encoding::Converter.asciicompat_encoding(string) -> Encoding | nil (22.0)

• 2.2.0

• 特異メソッド

同じ文字集合を持つ ASCII 互換エンコーディングを返します。

同じ文字集合を持つ ASCII 互換エンコーディングを返します。

@param string エンコーディング名
@param encoding エンコーディングオブジェクト
@return ASCII 互換エンコーディングのオブジェクトか nil

引数とエンコーディングと同じ文字集合を持つ ASCII 互換エンコーディングを返します。引数と戻り値、2 つのエンコーディング間では変換しても未定義文字の例外は発生しません。
引数が ASCII 互換エンコーディングである場合や、エンコーディングでない場合は nil を返します。

//emlist[][ruby]{
Encoding::Con...

• Encoding::Converter

Encoding::Converter.new(convpath) -> Encoding::Converter (22.0)

• 2.2.0

• 特異メソッド

Encoding::Converter オブジェクトを作成します。

Encoding::Converter オブジェクトを作成します。

@param source_encoding 変換元のエンコーディング
@param destination_encoding 変換先のエンコーディング
@param options 変換の詳細を指定する定数やハッシュ
@param convpath 変換経路の配列

options では String#encode でのハッシュオプションに加えて、以下の定数が利用可能です。

* Encoding::Converter::INVALID_REPLACE
* Encoding::Converter::UNDEF_RE...

• Encoding::Converter

Encoding::Converter.new(source_encoding, destination_encoding) -> Encoding::Converter (22.0)

• 2.2.0

• 特異メソッド

Encoding::Converter オブジェクトを作成します。

Encoding::Converter オブジェクトを作成します。

@param source_encoding 変換元のエンコーディング
@param destination_encoding 変換先のエンコーディング
@param options 変換の詳細を指定する定数やハッシュ
@param convpath 変換経路の配列

options では String#encode でのハッシュオプションに加えて、以下の定数が利用可能です。

* Encoding::Converter::INVALID_REPLACE
* Encoding::Converter::UNDEF_RE...

• Encoding::Converter

Encoding::Converter.new(source_encoding, destination_encoding, options) -> Encoding::Converter (22.0)

• 2.2.0

• 特異メソッド

Encoding::Converter オブジェクトを作成します。

Encoding::Converter オブジェクトを作成します。

@param source_encoding 変換元のエンコーディング
@param destination_encoding 変換先のエンコーディング
@param options 変換の詳細を指定する定数やハッシュ
@param convpath 変換経路の配列

options では String#encode でのハッシュオプションに加えて、以下の定数が利用可能です。

* Encoding::Converter::INVALID_REPLACE
* Encoding::Converter::UNDEF_RE...

• Encoding::Converter

Encoding::Converter.search_convpath(source_encoding, destination_encoding, options) -> Array (22.0)

• 2.2.0

• 特異メソッド

引数で指定した文字エンコーディングの変換の経路を配列にして返します。

引数で指定した文字エンコーディングの変換の経路を配列にして返します。

@param source_encoding 変換元の文字エンコーディングを Encoding オ
ブジェクトか文字列で指定します。

@param destination_encoding 変換先の文字エンコーディングを
Encoding オブジェクトか文字列で指定し
ます。

@param options 変換の詳細を指定する定数やハッシュを指定します。
...

• Encoding
• Encoding::Converter

絞り込み条件を変える

Enumerator::Lazy.new(obj, size=nil) {|yielder, *values| ... } -> Enumerator::Lazy (22.0)

• 2.2.0

• 特異メソッド

Lazy Enumerator を作成します。Enumerator::Lazy#force メソッドなどに よって列挙が実行されたとき、objのeachメソッドが実行され、値が一つずつ ブロックに渡されます。ブロックは、yielder を使って最終的に yield される値を 指定できます。

Lazy Enumerator を作成します。Enumerator::Lazy#force メソッドなどに
よって列挙が実行されたとき、objのeachメソッドが実行され、値が一つずつ
ブロックに渡されます。ブロックは、yielder を使って最終的に yield される値を
指定できます。

//emlist[Enumerable#filter_map と、その遅延評価版を定義する例][ruby]{
module Enumerable
def filter_map(&block)
map(&block).compact
end
end

class Enumerator::...

• Enumerator::Lazy

Fiber.current -> Fiber (22.0)

• 2.2.0

• 特異メソッド

このメソッドが評価されたコンテキストにおける Fiber のインスタンスを返します。

このメソッドが評価されたコンテキストにおける Fiber のインスタンスを返します。

//emlist[例:][ruby]{
fr = Fiber.new do
Fiber.current
end

fb = fr.resume
p fb.equal?(fr) # => true

p Fiber.current # => #<Fiber:0x91345e4>
p Fiber.current # => #<Fiber:0x91345e4>
//}

• Fiber

Fiber.new {|obj| ... } -> Fiber (22.0)

• 2.2.0

• 特異メソッド

与えられたブロックとともにファイバーを生成して返します。 ブロックは Fiber#resume に与えられた引数をその引数として実行されます。

与えられたブロックとともにファイバーを生成して返します。
ブロックは Fiber#resume に与えられた引数をその引数として実行されます。

ブロックが終了した場合は親にコンテキストが切り替わります。
その時ブロックの評価値が返されます。

//emlist[例:][ruby]{
a = nil
f = Fiber.new do |obj|
a = obj
:hoge
end

b = f.resume(:foo)
p a #=> :foo
p b #=> :hoge
//}

• Fiber

Fiber.yield(*arg = nil) -> object (22.0)

• 2.2.0

• 特異メソッド

現在のファイバーの親にコンテキストを切り替えます。

現在のファイバーの親にコンテキストを切り替えます。

コンテキストの切り替えの際に Fiber#resume に与えられた引数を yield メソッドは返します。

@param arg 現在のファイバーの親に渡したいオブジェクトを指定します。

@raise FiberError Fiber でのルートファイバーで呼ばれた場合に発生します。


//emlist[例:][ruby]{
a = nil
f = Fiber.new do
a = Fiber.yield()
end

f.resume()
f.resume(:foo)

p a #=> :foo
//}

• Fiber

Fiddle::CStruct.size -> Integer (22.0)

• 2.2.0

• 特異メソッド

構造体のサイズをバイト数で返します。

構造体のサイズをバイト数で返します。

このメソッドが返す値は C の構造体としてのサイズです。
Ruby のオブジェクトとしてはより大きなメモリを消費しています。

• Fiddle::CStruct

絞り込み条件を変える

Fiddle::Pointer.[](val) -> Fiddle::Pointer (22.0)

• 2.2.0

• 特異メソッド

与えられた val と関連した Pointer オブジェクトを生成して返します。

与えられた val と関連した Pointer オブジェクトを生成して返します。

val が文字列の場合は文字列が格納されているメモリ領域を指す Pointer
オブジェクトを返します。

IO オブジェクトの場合は FILE ポインタを表す Pointer オブジェクトを返します。

val に to_ptr メソッドが定義されている場合は、val.to_ptr を呼び、
Pointer オブジェクトに変換したものを返します。

val が整数の場合はそれをアドレスとする Pointer オブジェクトを返します。

上以外の場合は、整数に変換(to_int)し
それをアドレスとする P...

• Fiddle::Pointer

Fiddle::Pointer.to_ptr(val) -> Fiddle::Pointer (22.0)

• 2.2.0

• 特異メソッド

与えられた val と関連した Pointer オブジェクトを生成して返します。

与えられた val と関連した Pointer オブジェクトを生成して返します。

val が文字列の場合は文字列が格納されているメモリ領域を指す Pointer
オブジェクトを返します。

IO オブジェクトの場合は FILE ポインタを表す Pointer オブジェクトを返します。

val に to_ptr メソッドが定義されている場合は、val.to_ptr を呼び、
Pointer オブジェクトに変換したものを返します。

val が整数の場合はそれをアドレスとする Pointer オブジェクトを返します。

上以外の場合は、整数に変換(to_int)し
それをアドレスとする P...

• Fiddle::Pointer

File.absolute_path(file_name, dir_string=nil) -> String (22.0)

• 2.2.0

• 特異メソッド

file_name を絶対パスに変換した文字列を返します。

file_name を絶対パスに変換した文字列を返します。

相対パスの場合はカレントディレクトリを基準とします。
dir_string を渡した場合はそのディレクトリを基準とします。

File.expand_path と異なり、 file_name 先頭が "~" である場合
それは展開されません。普通のディレクトリ名として処理されます。

//emlist[例][ruby]{
p Dir.getwd #=> "/home/matz/work/bar"
p ENV["HOME"] #=> "/home/mat...

• File

File.atime(filename) -> Time (22.0)

• 2.2.0

• 特異メソッド

最終アクセス時刻を返します。

最終アクセス時刻を返します。

@param filename ファイル名を表す文字列か IO オブジェクトを指定します。

@raise Errno::EXXX ファイルの時刻の取得に失敗した場合に発生します。

//emlist[例][ruby]{
File.atime(__FILE__) # => 2017-11-28 22:38:44 +0900
//}

• File

File.birthtime(filename) -> Time (22.0)

• 2.2.0

• 特異メソッド

作成された時刻を返します。

作成された時刻を返します。

@param filename ファイル名を表す文字列か IO オブジェクトを指定します。

@raise Errno::EXXX ファイルの時刻の取得に失敗した場合に発生します。

@raise NotImplementedError Windows のような birthtime のない環境で発生します。

//emlist[例][ruby]{
File.birthtime("testfile") #=> Wed Apr 09 08:53:13 CDT 2003
//}

• File

絞り込み条件を変える

File.chown(owner, group, *filename) -> Integer (22.0)

• 2.2.0

• 特異メソッド

ファイルのオーナーとグループを変更します。スーパーユーザだけがファ イルのオーナーとグループを変更できます。変更を行ったファイルの数を 返します。

ファイルのオーナーとグループを変更します。スーパーユーザだけがファ
イルのオーナーとグループを変更できます。変更を行ったファイルの数を
返します。

@param filename ファイル名を表す文字列を指定します。

@param owner chown(2) と同様に数値で指定します。nil または -1 を指定することで、オーナーを現在のままにすることができます。

@param group chown(2) と同様に数値で指定します。nil または -1 を指定することで、グループを現在のままにすることができます。

@raise Errno::EXXX 変更に失敗した場合に発生し...

• File

File.ctime(filename) -> Time (22.0)

• 2.2.0

• 特異メソッド

状態が最後に変更された時刻を返します。 状態の変更とは chmod などによるものです。

状態が最後に変更された時刻を返します。
状態の変更とは chmod などによるものです。

@param filename ファイル名を表す文字列か IO オブジェクトを指定します。

@raise Errno::EXXX ファイルの時刻の取得に失敗した場合に発生します。

//emlist[例:][ruby]{
IO.write("testfile", "test")
File.ctime("testfile") # => 2017-11-30 22:40:49 +0900
File.chmod(0755, "testfile")
File.ctime("testfile") # => 2...

• File

File.delete(*filename) -> Integer (22.0)

• 2.2.0

• 特異メソッド

ファイルを削除します。削除したファイルの数を返します。 削除に失敗した場合は例外 Errno::EXXX が発生します。

ファイルを削除します。削除したファイルの数を返します。
削除に失敗した場合は例外 Errno::EXXX が発生します。

このメソッドは通常ファイルの削除用で、ディレクトリの削除には
Dir.rmdir を使います。

@param filename ファイル名を表す文字列を指定します。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
IO.write("test.txt", "test")
p File.exist?("test.txt") # => true
p File.delete("test.txt") # => ...

• Errno::EXXX
• File

File.expand_path(path, default_dir = &#39;.&#39;) -> String (22.0)

• 2.2.0

• 特異メソッド

path を絶対パスに展開した文字列を返します。 path が相対パスであれば default_dir を基準にします。

path を絶対パスに展開した文字列を返します。
path が相対パスであれば default_dir を基準にします。

先頭の ~ はホームディレクトリ(環境変数 HOME が使われます)に、
~USER はそのユーザのホームディレクトリに展開されます。

//emlist[例][ruby]{
p Dir.getwd #=> "/home/matz/work/foo"
p ENV["HOME"] #=> "/home/matz"
p File.expand_path("..") #=> "/h...

• File

File.extname(filename) -> String (22.0)

• 2.2.0

• 特異メソッド

ファイル名 filename の拡張子部分(最後の "." に続く文字列)を 返します。ディレクトリ名に含まれる "." や、ファイル名先頭の "." は拡張子の一部としては見なされません。filename に拡張子が含 まれない場合は空文字列を返します。

ファイル名 filename の拡張子部分(最後の "." に続く文字列)を
返します。ディレクトリ名に含まれる "." や、ファイル名先頭の "."
は拡張子の一部としては見なされません。filename に拡張子が含
まれない場合は空文字列を返します。

//emlist[例][ruby]{
p File.extname("foo/foo.txt") # => ".txt"
p File.extname("foo/foo.tar.gz") # => ".gz"
p File.extname("foo/bar") # => ""
p File.extname("f...

• File

絞り込み条件を変える

File.ftype(filename) -> String (22.0)

• 2.2.0

• 特異メソッド

ファイルのタイプを表す文字列を返します。

ファイルのタイプを表す文字列を返します。

文字列は以下のうちのいずれかです。File.lstat(filename).ftype と同じです。
シンボリックリンクに対して "link" を返します。

* "file"
* "directory"
* "characterSpecial"
* "blockSpecial"
* "fifo"
* "link"
* "socket"
* "unknown"

@param filename ファイル名を表す文字列を指定します。

@raise Errno::EXXX 情報の取得に失敗した場合に発生します。

//emlist[...

• File

File.join(*item) -> String (22.0)

• 2.2.0

• 特異メソッド

File::SEPARATORを間に入れて文字列を連結します。platform/DOSISH-supportで環境依存になる予定です。

File::SEPARATORを間に入れて文字列を連結します。platform/DOSISH-supportで環境依存になる予定です。

@param item 連結したいディレクトリ名やファイル名を文字列（もしくは文字列を要素に持つ配列）で与えます。
文字列AとBを連結する際に、Aの末尾の文字とBの先頭の文字がFile::SEPARATORであった場合には、
まずこれらを削除した上で改めてFile::SEPARATORを間に入れて連結します。
引数の中に配列がある場合は配列要素を再帰的に展開します。空の配列は空文字列に...

• File
• platform/DOSISH-support

File.lchmod(mode, *filename) -> Integer (22.0)

• 2.2.0

• 特異メソッド

File.chmod と同様ですが、シンボリックリンクに関してリンクそのものの モードを変更します。

File.chmod と同様ですが、シンボリックリンクに関してリンクそのものの
モードを変更します。

@param filename ファイル名を表す文字列を指定します。

@param mode chmod(2) と同様に整数で指定します。

@raise NotImplementedError lchmod(2) を実装していないシステムでこのメソッドを呼び出すと発生します。

@raise Errno::EXXX モードの変更に失敗した場合に発生します。

//emlist[例][ruby]{
IO.write("testfile", "test")
File.symlink("te...

• File

File.lchown(owner, group, *filename) -> Integer (22.0)

• 2.2.0

• 特異メソッド

File#chown と同様ですが、 シンボリックリンクに関してリンクそのもののオーナー、 グループを変更します。

File#chown と同様ですが、
シンボリックリンクに関してリンクそのもののオーナー、
グループを変更します。

@param filename ファイル名を表す文字列を指定します。

@param owner chown(2) と同様に数値で指定します。nil または -1 を指定することで、オーナーを現在のままにすることができます。

@param group chown(2) と同様に数値で指定します。nil または -1 を指定することで、グループを現在のままにすることができます。

@raise NotImplementedError lchown(2) を実装していないシステ...

• File

File.link(old, new) -> 0 (22.0)

• 2.2.0

• 特異メソッド

old を指す new という名前のハードリンクを 生成します。old はすでに存在している必要があります。 ハードリンクに成功した場合は 0 を返します。

old を指す new という名前のハードリンクを
生成します。old はすでに存在している必要があります。
ハードリンクに成功した場合は 0 を返します。

失敗した場合は例外 Errno::EXXX が発生します。

@param old ファイル名を表す文字列を指定します。

@param new ファイル名を表す文字列を指定します。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
IO.write("testfile", "test")
File.link("testfile", "testlink") # => 0...

• Errno::EXXX
• File

絞り込み条件を変える

File.lstat(filename) -> File::Stat (22.0)

• 2.2.0

• 特異メソッド

File.statと同様ですが、シンボリックリンクに関してリンクそのものの 情報を File::Stat として返します。lstat(2) を実装していないシステムでは、File.stat と同じです。

File.statと同様ですが、シンボリックリンクに関してリンクそのものの
情報を File::Stat として返します。lstat(2) を実装していないシステムでは、File.stat と同じです。

@param filename ファイル名を表す文字列を指定します。

@raise Errno::EXXX 情報の取得に失敗した場合に発生します。

//emlist[例][ruby]{
# link.rb は t.rb のシンボリックリンク
File.lstat("link.rb") == File.stat("t.rb") # => false
File.stat("link.rb...

• File

File.mtime(filename) -> Time (22.0)

• 2.2.0

• 特異メソッド

最終更新時刻を返します。

最終更新時刻を返します。

@param filename ファイル名を表す文字列か IO オブジェクトを指定します。

@raise Errno::EXXX ファイルの時刻の取得に失敗した場合に発生します。

//emlist[例][ruby]{
File.mtime(__FILE__) # => 2017-12-03 03:16:22 +0900
//}

• File

File.path(filename) -> String (22.0)

• 2.2.0

• 特異メソッド

指定されたファイル名を文字列で返します。filename が文字列でない場合は、to_path メソッドを呼びます。

指定されたファイル名を文字列で返します。filename が文字列でない場合は、to_path メソッドを呼びます。

@param filename ファイル名を表す文字列か to_path メソッドが定義されたオブジェクトを指定します。

//emlist[例][ruby]{
require 'pathname'

class MyPath
def initialize(path)
@path = path
end
def to_path
File.absolute_path(@path)
end
end

File.path("/dev/null") ...

• File

File.readlink(path) -> String (22.0)

• 2.2.0

• 特異メソッド

シンボリックリンクのリンク先のパスを文字列で返します。

シンボリックリンクのリンク先のパスを文字列で返します。

@param path シンボリックリンクを表す文字列を指定します。

@raise Errno::EXXX 指定された path がシンボリックリンクでない場合や、リンクの読み取りに失敗した場合に発生します。

//emlist[例:][ruby]{
IO.write("testfile", "test")
File.symlink("testfile", "testlink") # => 0
File.readlink("testlink") # => "testfile"
//}

• File

File.realpath(pathname, basedir = nil) -> String (22.0)

• 2.2.0

• 特異メソッド

与えられた pathname に対応する絶対パスを返します。

与えられた pathname に対応する絶対パスを返します。

pathname の全てのコンポーネントは存在しなければなりません。

@param pathname ファイル名を指定します。

@param basedir ベースディレクトリを指定します。省略するとカレントディレクトリを使用します。

@raise Errno::ENOENT ファイルが存在しない場合に発生します。

//emlist[例][ruby]{
ENV["HOME"] # => "/home/matz"
File.symlink("testfile", "testlink"...

• File

絞り込み条件を変える

File.rename(from, to) -> 0 (22.0)

• 2.2.0

• 特異メソッド

ファイルの名前を変更します。ディレクトリが異なる場合には移動も行い ます。rename(2) を参照してください。移動先のファ イルが存在する時には上書きされます。

ファイルの名前を変更します。ディレクトリが異なる場合には移動も行い
ます。rename(2) を参照してください。移動先のファ
イルが存在する時には上書きされます。

ファイルの移動に成功した場合 0 を返します。失敗した場合は例外
Errno::EXXX が発生します。

@param from ファイルの名前を文字列で与えます。

@param to 新しいファイル名を文字列で与えます。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
begin
File.rename("testfile", "testfile.bak")...

• Errno::EXXX
• File

File.split(pathname) -> [String] (22.0)

• 2.2.0

• 特異メソッド

pathname を dirname とbasename に分割して、2 要 素の配列を返します。

pathname を dirname とbasename に分割して、2 要
素の配列を返します。

//emlist[][ruby]{
[File.dirname(pathname), File.basename(pathname)]
//}

と同じです。

@param pathname パス名を表す文字列を指定します。

• File

File.stat(filename) -> File::Stat (22.0)

• 2.2.0

• 特異メソッド

filename の情報を含む File::Stat オブジェクトを生成し て返します。

filename の情報を含む File::Stat オブジェクトを生成し
て返します。

@param filename ファイル名を表す文字列を指定します。

@raise Errno::EXXX 情報の取得に失敗した場合に発生します。

//emlist[例][ruby]{
File.stat("testfile").class # => File::Stat
File.stat("testfile").mtime # => 2017-12-10 01:13:56 +0900
//}

@see IO#stat, File#lstat

• File
• File::Stat

File.symlink(old, new) -> 0 (22.0)

• 2.2.0

• 特異メソッド

old への new という名前のシンボリックリンクを生成します。

old への new という名前のシンボリックリンクを生成します。

シンボリックリンクの作成に成功すれば 0 を返します。失敗した場合は
例外 Errno::EXXX が発生します。

@param old ファイル名を表す文字列を指定します。

@param new シンボリックリンクを表す文字列を指定します。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
File.symlink("testfile", "testlink") # => 0
//}

• Errno::EXXX
• File

File.truncate(path, length) -> 0 (22.0)

• 2.2.0

• 特異メソッド

path で指定されたファイルのサイズを最大 length バイト にします。

path で指定されたファイルのサイズを最大 length バイト
にします。

サイズの変更に成功すれば 0 を返します。失敗した場合は例外
Errno::EXXX が発生します。

@param path パスを表す文字列を指定します。

@param length 変更したいサイズを整数で与えます。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
IO.write("testfile", "1234567890")
File.truncate("testfile", 5) # => 0
File.size("testfil...

• Errno::EXXX
• File

絞り込み条件を変える

File.umask(umask) -> Integer (22.0)

• 2.2.0

• 特異メソッド

umask を変更します。変更前の umask の値を返します。

umask を変更します。変更前の umask の値を返します。

@param umask 設定したい umask の値を整数で指定します。

//emlist[例][ruby]{
File.umask(0006) # => 18
File.umask # => 6
//}

@see umask(2)

• File

File.unlink(*filename) -> Integer (22.0)

• 2.2.0

• 特異メソッド

ファイルを削除します。削除したファイルの数を返します。 削除に失敗した場合は例外 Errno::EXXX が発生します。

ファイルを削除します。削除したファイルの数を返します。
削除に失敗した場合は例外 Errno::EXXX が発生します。

このメソッドは通常ファイルの削除用で、ディレクトリの削除には
Dir.rmdir を使います。

@param filename ファイル名を表す文字列を指定します。

@raise Errno::EXXX 失敗した場合に発生します。

//emlist[例][ruby]{
IO.write("test.txt", "test")
p File.exist?("test.txt") # => true
p File.delete("test.txt") # => ...

• Errno::EXXX
• File

File.world_readable?(path) -> Integer | nil (22.0)

• 2.2.0

• 特異メソッド

path が全てのユーザから読めるならばそのファイルのパーミッションを表す 整数を返します。そうでない場合は nil を返します。

path が全てのユーザから読めるならばそのファイルのパーミッションを表す
整数を返します。そうでない場合は nil を返します。

整数の意味はプラットフォームに依存します。

@param path パスを表す文字列か IO オブジェクトを指定します。

//emlist[例][ruby]{
m = File.world_readable?("/etc/passwd")
"%o" % m # => "644"
//}

• File

File.world_writable?(path) -> bool (22.0)

• 2.2.0

• 特異メソッド

path が全てのユーザから書き込めるならば、そのファイルのパーミッションを表す 整数を返します。そうでない場合は nil を返します。

path が全てのユーザから書き込めるならば、そのファイルのパーミッションを表す
整数を返します。そうでない場合は nil を返します。

整数の意味はプラットフォームに依存します。

@param path パスを表す文字列か IO オブジェクトを指定します。

//emlist[例][ruby]{
m = File.world_writable?("/tmp")
"%o" % m #=> "777"
//}

• File

FileUtils.collect_method(opt) -> Array (22.0)

• 2.2.0

• 特異メソッド

与えられたオプションを持つメソッド名の配列を返します。

与えられたオプションを持つメソッド名の配列を返します。

@param opt オプション名をシンボルで指定します。

//emlist[][ruby]{
require 'fileutils'
FileUtils.collect_method(:preserve) # => ["cp", "cp_r", "copy", "install"]
//}

• FileUtils

絞り込み条件を変える

FileUtils.commands -> Array (22.0)

• 2.2.0

• 特異メソッド

何らかのオプションを持つメソッド名の配列を返します。

何らかのオプションを持つメソッド名の配列を返します。

//emlist[][ruby]{
require 'fileutils'
FileUtils.commands # => ["chmod", "cp", "cp_r", "install", ...]
//}

• FileUtils

FileUtils.options -> Array (22.0)

• 2.2.0

• 特異メソッド

オプション名の配列を返します。

オプション名の配列を返します。

//emlist[][ruby]{
require 'fileutils'
FileUtils.options
# => ["verbose", "mode", "noop", "parents", "force", "preserve", "dereference_root", "remove_destination", "secure", "mtime", "nocreate"]
//}

• FileUtils

FileUtils.options_of(mid) -> Array (22.0)

• 2.2.0

• 特異メソッド

与えられたメソッド名で使用可能なオプション名の配列を返します。

与えられたメソッド名で使用可能なオプション名の配列を返します。

@param mid メソッド名を指定します。

//emlist[][ruby]{
require 'fileutils'
FileUtils.options_of(:rm) # => ["noop", "verbose", "force"]
//}

• FileUtils

GC.count -> Integer (22.0)

• 2.2.0

• 特異メソッド

プロセス開始からガーベージコレクトを実行した回数を Integer で返し ます。

プロセス開始からガーベージコレクトを実行した回数を Integer で返し
ます。

//emlist[例][ruby]{
GC.count # => 3
//}

• GC
• Integer

GC.disable -> bool (22.0)

• 2.2.0

• 特異メソッド

ガーベージコレクトを禁止します。

ガーベージコレクトを禁止します。

前回の禁止状態を返します(禁止されていたなら true, GC が有効であったなら、
false)。

//emlist[例][ruby]{
GC.disable # => false
GC.disable # => true
//}

@see GC.enable

• GC

絞り込み条件を変える

GC.enable -> bool (22.0)

• 2.2.0

• 特異メソッド

ガーベージコレクトを許可します。

ガーベージコレクトを許可します。

前回の禁止状態を返します(禁止されていたなら true, GC が有効であったなら、
false)。

@see GC.disable

//emlist[例][ruby]{
GC.disable # => false
GC.enable # => true
GC.enable # => false
//}

• GC

GC.latest_gc_info(key) -> object (22.0)

• 2.2.0

• 特異メソッド

最新のGCの情報を返します。

最新のGCの情報を返します。

@param result_hash 戻り値のためのハッシュを指定します。省略した場合は新
しくハッシュを作成します。result_hash の内容は上書き
されます。

@param key 得られる情報から特定の情報を取得したい場合にキーを
Symbol で指定します。

//emlist[例][ruby]{
latest = GC.latest_gc_info
latest # => {:major_by=>nil, :gc_by=>:newobj, :ha...

• GC

GC.latest_gc_info(result_hash = {}) -> Hash (22.0)

• 2.2.0

• 特異メソッド

最新のGCの情報を返します。

最新のGCの情報を返します。

@param result_hash 戻り値のためのハッシュを指定します。省略した場合は新
しくハッシュを作成します。result_hash の内容は上書き
されます。

@param key 得られる情報から特定の情報を取得したい場合にキーを
Symbol で指定します。

//emlist[例][ruby]{
latest = GC.latest_gc_info
latest # => {:major_by=>nil, :gc_by=>:newobj, :ha...

• GC

GC.stat(key) -> Numeric (22.0)

• 2.2.0

• 特異メソッド

GC 内部の統計情報を Hash で返します。

GC 内部の統計情報を Hash で返します。

@param result_hash 戻り値のためのハッシュを指定します。省略した場合は新
しくハッシュを作成します。result_hash の内容は上書き
されます。


@param key 得られる統計情報から特定の情報を取得したい場合にキーを
Symbol で指定します。

@return GC 内部の統計情報をHash で返します。
引数 key を指定した場合は数値を返します。

GC.stat
# =>
...

• GC
• Hash

GC.stat(result_hash = {}) -> {Symbol => Integer} (22.0)

• 2.2.0

• 特異メソッド

GC 内部の統計情報を Hash で返します。

GC 内部の統計情報を Hash で返します。

@param result_hash 戻り値のためのハッシュを指定します。省略した場合は新
しくハッシュを作成します。result_hash の内容は上書き
されます。


@param key 得られる統計情報から特定の情報を取得したい場合にキーを
Symbol で指定します。

@return GC 内部の統計情報をHash で返します。
引数 key を指定した場合は数値を返します。

GC.stat
# =>
...

• GC
• Hash

絞り込み条件を変える

GC.stress=(value) (22.0)

• 2.2.0

• 特異メソッド

GCのストレスモードを引数 value に設定します。 引数 value が真に設定されている間は、GC を行えるすべての機会に GC を行います。

GCのストレスモードを引数 value に設定します。
引数 value が真に設定されている間は、GC を行えるすべての機会に GC を行います。

この機能はデバッグ用途に提供されています。ストレスモードを有効にすると
プログラムのパフォーマンスが低下します。

@param value 任意のオブジェクト。整数以外の値を指定した場合は真偽値として解釈されます。
整数を指定する場合は以下のフラグをOR演算した値を指定します。
: 0x01
マイナー GC を動作させる場合に指定します。
: 0x02
sweep を遅らせる(Lazy Sweep を行う)...

• GC

GC::Profiler.report(out = $stdout) -> nil (22.0)

• 2.2.0

• 特異メソッド

GC::Profiler.result の結果を out に出力します。

GC::Profiler.result の結果を out に出力します。

@param out 結果の出力先を指定します。デフォルトは $stdout です。

//emlist[例][ruby]{
GC::Profiler.enable
GC.start
GC::Profiler.report

# => GC 4 invokes.
# Index Invoke Time(sec) Use Size(byte) Total Size(byte) Total Object GC Time(ms)
# 1...

• GC::Profiler

GC::Profiler.total_time -> Float (22.0)

• 2.2.0

• 特異メソッド

GC のプロファイル情報から GC の総計時間を計算し、msec 単位で返します。

GC のプロファイル情報から GC の総計時間を計算し、msec 単位で返します。

//emlist[例][ruby]{
GC::Profiler.enable
GC.start
GC::Profiler.total_time # => 0.0011530000000000012
//}

• GC::Profiler

Gem::Installer.exec_format -> String (22.0)

• 2.2.0

• 特異メソッド

実行ファイル名のフォーマットを返します。

実行ファイル名のフォーマットを返します。

指定しない場合は ruby コマンドと同じフォーマットを使用します。

• Gem::Installer

Gem::Requirement.create(input) -> Gem::Requirement (22.0)

• 2.2.0

• 特異メソッド

Gem::Requirement のインスタンスを作成するためのファクトリメソッドです。

Gem::Requirement のインスタンスを作成するためのファクトリメソッドです。

@param input 文字列か配列か Gem::Requirement, Gem::Version のインスタンス
のいずれかを指定します。

@return 上記以外の値を input に指定するとデフォルト値を返します。

//emlist[][ruby]{
pp Gem::Requirement.create("~> 3.2.1")
# => Gem::Requirement.new(["~> 3.2.1"])
//}

@see Gem::Requirement....

• Gem::Requirement
• Gem::Version

絞り込み条件を変える

Gem::Requirement.default -> Gem::Requirement (22.0)

• 2.2.0

• 特異メソッド

ゼロ以上 ( '>= 0' ) を指定して作成された Gem::Requirement のインスタンスを返します。

ゼロ以上 ( '>= 0' ) を指定して作成された Gem::Requirement のインスタンスを返します。

//emlist[][ruby]{
pp Gem::Requirement.default
# => Gem::Requirement.new([">= 0"])
//}

• Gem::Requirement

Gem::Requirement.new(requirements) -> Gem::Requirement (22.0)

• 2.2.0

• 特異メソッド

Gem::Requirement のインスタンスを作成します。

Gem::Requirement のインスタンスを作成します。

@param requirements 文字列か配列か Gem::Version のインスタンスを指定します。

//emlist[][ruby]{
pp Gem::Requirement.new("~> 3.2.1")
# => Gem::Requirement.new(["~> 3.2.1"])
//}

@see Gem::Requirement#parse, Gem::Requirement.create

• Gem::Requirement
• Gem::Version

Gem::Requirement.parse(obj) -> Array (22.0)

• 2.2.0

• 特異メソッド

バージョンの必要上件をパースして比較演算子とバージョンを要素とする二要素の配列を返します。

バージョンの必要上件をパースして比較演算子とバージョンを要素とする二要素の配列を返します。

@param obj 必要上件を表す文字列または Gem::Version のインスタンスを指定します。
@return 比較演算子と Gem::Version のインスタンスを要素とする二要素の配列を返します。
@raise ArgumentError obj に不正なオブジェクトを指定すると発生します。

//emlist[][ruby]{
p Gem::Requirement.parse("~> 3.2.1") # => ["~>", #<Gem::Version "3.2.1">]
//}
...

• Gem::Requirement
• Gem::Version

Gem::Specification.from_yaml(input) -> Gem::Specification (22.0)

• 2.2.0

• 特異メソッド

YAML ファイルから gemspec をロードします。

YAML ファイルから gemspec をロードします。

YAML ファイルから Gem::Specification をロードすると、通常の Ruby オブジェクトの
初期化ルーチン (#initialize) を通りません。このメソッドは初期化ルーチンの一部を実行し、
gemspec のバージョンチェックも行います。

@param input 文字列か IO オブジェクトを指定します。

• Gem::Specification
• IO

Gem::Version.correct?(version) -> 0 | nil (22.0)

• 2.2.0

• 特異メソッド

version が正しいバージョンであれば 0 を返します。そうでなければ nil を返します。

version が正しいバージョンであれば 0 を返します。そうでなければ nil を返します。

//emlist[][ruby]{
p Gem::Version.correct?("9.1") # => 0
p Gem::Version.correct?("incorrect") # => nil

p Gem::Version.correct?(nil) # => 0
//}

@param version バージョンを文字列か数値で指定します。

• Gem::Version

絞り込み条件を変える