検索結果

File.readable_real?(path) -> bool (36610.0)

• 3.3

• 特異メソッド

FileTest.#readable_real? と同じです。

FileTest.#readable_real? と同じです。

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

• File

Random.rand(range) -> Integer | Float (27610.0)

• 3.3

• 特異メソッド

擬似乱数を発生させます。

擬似乱数を発生させます。

Random#rand を参照してください。

擬似乱数生成器が Kernel.#rand と共通なため Kernel.#srand などの影響を受けます。

@param max 乱数値の上限を正の整数または実数で指定します。
@param range 発生させる乱数値の範囲を Range オブジェクトで指定します。
range の境界は数値でなければなりません。

@raise Errno::EDOM rand(1..Float::INFINITY) などのように範囲に問題があるときに発生します。
@raise ArgumentE...

• Random
• Range

TracePoint.trace(*events) {|obj| ... } -> TracePoint (27610.0)

• 3.3

• 特異メソッド

新しい TracePoint オブジェクトを作成して自動的にトレースを開始し ます。TracePoint.new のコンビニエンスメソッドです。

新しい TracePoint オブジェクトを作成して自動的にトレースを開始し
ます。TracePoint.new のコンビニエンスメソッドです。

@param events トレースするイベントを String か Symbol で任
意の数指定します。指定できる値については
TracePoint.new を参照してください。

//emlist[例][ruby]{
trace = TracePoint.trace(:call) { |tp| [tp.lineno, tp.event] }
# => #<TracePoint:0x00...

• String
• Symbol
• TracePoint

Random.rand -> Float (27310.0)

• 3.3

• 特異メソッド

擬似乱数を発生させます。

擬似乱数を発生させます。

Random#rand を参照してください。

擬似乱数生成器が Kernel.#rand と共通なため Kernel.#srand などの影響を受けます。

@param max 乱数値の上限を正の整数または実数で指定します。
@param range 発生させる乱数値の範囲を Range オブジェクトで指定します。
range の境界は数値でなければなりません。

@raise Errno::EDOM rand(1..Float::INFINITY) などのように範囲に問題があるときに発生します。
@raise ArgumentE...

• Random
• Range

Random.rand(max) -> Integer | Float (27310.0)

• 3.3

• 特異メソッド

擬似乱数を発生させます。

擬似乱数を発生させます。

Random#rand を参照してください。

擬似乱数生成器が Kernel.#rand と共通なため Kernel.#srand などの影響を受けます。

@param max 乱数値の上限を正の整数または実数で指定します。
@param range 発生させる乱数値の範囲を Range オブジェクトで指定します。
range の境界は数値でなければなりません。

@raise Errno::EDOM rand(1..Float::INFINITY) などのように範囲に問題があるときに発生します。
@raise ArgumentE...

• Random
• Range

絞り込み条件を変える

Random.srand -> Integer (27310.0)

• 3.3

• 特異メソッド

デフォルトの擬似乱数生成器の種を設定し、古い種を返します。 Kernel.#srand と同じです。

デフォルトの擬似乱数生成器の種を設定し、古い種を返します。
Kernel.#srand と同じです。

@param number 擬似乱数発生器の種を整数で指定します。


@see Kernel.#rand

• Random

Random.srand(number) -> Integer (27310.0)

• 3.3

• 特異メソッド

デフォルトの擬似乱数生成器の種を設定し、古い種を返します。 Kernel.#srand と同じです。

デフォルトの擬似乱数生成器の種を設定し、古い種を返します。
Kernel.#srand と同じです。

@param number 擬似乱数発生器の種を整数で指定します。


@see Kernel.#rand

• Random

Random.urandom(size) -> String (27310.0)

• 3.3

• 特異メソッド

プラットフォームの提供する機能を使って、文字列を返します。

プラットフォームの提供する機能を使って、文字列を返します。

@param size 結果の文字列のサイズをバイト数で指定します。

@return 返り値はバイナリ形式で、暗号的に安全な擬似乱数だと期待できます。
@raise RuntimeError プラットフォームの提供する機能の準備に失敗した場合に発生します。

2017年の時点で、Linuxのmanpage(random(7))には「今日256ビット以上の
セキュリティを約束できる暗号化プリミティブが入手可能だとは期待できません」と
書いてあります。そのため、sizeとして32より大きい値を指定することには疑問の
余地があります。...

• Random

RubyVM::InstructionSequence.load_from_binary(binary) -> RubyVM::InstructionSequence (27310.0)

• 3.3

• 特異メソッド

RubyVM::InstructionSequence#to_binaryにより作られたバイナリフォーマットの文字列からiseqのオブジェクトをロードします。

RubyVM::InstructionSequence#to_binaryにより作られたバイナリフォーマットの文字列からiseqのオブジェクトをロードします。

このローダーは検証機構をもっておらず、壊れたり改変されたバイナリを読み込むと深刻な問題を引き起こします。

他者により提供されたバイナリデータはロードすべきではありません。自分が変換したバイナリデータを使うべきです。

//emlist[例][ruby]{
iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
binary = iseq.to_binary
RubyVM:...

• RubyVM::InstructionSequence

RubyVM::InstructionSequence.load_from_binary_extra_data(binary) -> String (27310.0)

• 3.3

• 特異メソッド

バイナリフォーマットの文字列から埋め込まれたextra_dataを取り出します。

バイナリフォーマットの文字列から埋め込まれたextra_dataを取り出します。

//emlist[例][ruby]{
iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
binary = iseq.to_binary("extra_data")
RubyVM::InstructionSequence.load_from_binary_extra_data(binary) # => extra_data
//}

@see RubyVM::InstructionSequence#to_binary

• RubyVM::InstructionSequence

絞り込み条件を変える

Thread.current -> Thread (27310.0)

• 3.3

• 特異メソッド

現在実行中のスレッド(カレントスレッド)を返します。

現在実行中のスレッド(カレントスレッド)を返します。

p Thread.current #=> #<Thread:0x4022e6fc run>

• Thread

Thread.report_on_exception -> bool (27310.0)

• 3.3

• 特異メソッド

真の時は、いずれかのスレッドが例外によって終了した時に、その内容を $stderr に報告します。

真の時は、いずれかのスレッドが例外によって終了した時に、その内容を $stderr に報告します。

デフォルトは true です。

Thread.new { 1.times { raise } }

は $stderr に以下のように出力します:

#<Thread:...> terminated with exception (report_on_exception is true):
Traceback (most recent call last):
2: from -e:1:in `block in <main>'
1: fro...

• Thread

Thread.report_on_exception=(newstate) (27310.0)

• 3.3

• 特異メソッド

真の時は、いずれかのスレッドが例外によって終了した時に、その内容を $stderr に報告します。

真の時は、いずれかのスレッドが例外によって終了した時に、その内容を $stderr に報告します。

デフォルトは true です。

Thread.new { 1.times { raise } }

は $stderr に以下のように出力します:

#<Thread:...> terminated with exception (report_on_exception is true):
Traceback (most recent call last):
2: from -e:1:in `block in <main>'
1: fro...

• Thread

Warning.warn(message, category: nil) -> nil (27310.0)

• 3.3

• 特異メソッド

引数 message を標準エラー出力 $stderr に出力します。

引数 message を標準エラー出力 $stderr に出力します。

本メソッドはRubyが出力する全ての警告に対して呼び出されます。
そのため本メソッドをオーバーライドすることで Ruby から出力される警告の動作を変更できます。
またオーバーライドしたメソッドからは super を呼び出すことで、デフォルトの動作である $stderr への出力ができます。

//emlist[][ruby]{
module Warning
# 警告メッセージに category を表示し、message 末尾に !!! を追加する
def self.warn(message, categor...

• Warning

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

• 3.3

• 特異メソッド

ディレクトリ 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] (18610.0)

• 3.3

• 特異メソッド

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

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

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

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

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

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

• Dir

ENV.filter -> Enumerator (18610.0)

• 3.3

• 特異メソッド

環境変数名と値についてブロックを評価し、真を返したものを集めたハッシュ を返します。

環境変数名と値についてブロックを評価し、真を返したものを集めたハッシュ
を返します。

• ENV

ENV.rassoc(value) -> Array | nil (18610.0)

• 3.3

• 特異メソッド

自身が与えられた値に対応する要素を持つとき、見つかった要素のキーと値のペアを 配列として返します。

自身が与えられた値に対応する要素を持つとき、見つかった要素のキーと値のペアを
配列として返します。

@param value 検索する値を指定します。

@see Hash#rassoc

• ENV

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

• 3.3

• 特異メソッド

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

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

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

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

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

• Encoding
• Encoding::Converter

FrozenError.new(error_message = "") -> FrozenError (18610.0)

• 3.3

• 特異メソッド

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

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

@param error_message エラーメッセージを表す文字列です

@param receiver 原因となったメソッド呼び出しのレシーバです

//emlist[][ruby]{
err = FrozenError.new("message")
p err # => #<FrozenError: message>
//}

• FrozenError

絞り込み条件を変える

FrozenError.new(error_message = "", receiver:) -> FrozenError (18610.0)

• 3.3

• 特異メソッド

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

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

@param error_message エラーメッセージを表す文字列です

@param receiver 原因となったメソッド呼び出しのレシーバです

//emlist[][ruby]{
err = FrozenError.new("message")
p err # => #<FrozenError: message>
//}

• FrozenError

IO.binwrite(path, string, offset=nil) -> Integer (18610.0)

• 3.3

• 特異メソッド

path で指定されるファイルを開き、string を書き込み、 閉じます。

path で指定されるファイルを開き、string を書き込み、
閉じます。

ファイルを開くときの mode が "wb:ASCII-8BIT" で、バイナリモードが有効
である点以外は IO.write と同じです。

Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドを実行し、コマンドの出力を標準出力に書き込みます。

offset を指定するとその位置までシークします。

offset を指定しないと、書き込みの末尾でファイルを
切り捨てます。

@param path ファイル名文字列
@param string 書き込む文字列
@param...

• IO

IO.write(path, string, **opts) -> Integer (18610.0)

• 3.3

• 特異メソッド

path で指定されるファイルを開き、string を書き込み、 閉じます。

path で指定されるファイルを開き、string を書き込み、
閉じます。

Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドを実行し、コマンドの出力を標準出力に書き込みます。

offset を指定するとその位置までシークします。

offset を指定しないと、書き込みの末尾でファイルを
切り捨てます。

キーワード引数はファイルを開くときに使われ、エンコーディングなどを指定することができます。
詳しくは IO.open を見てください。

@param path ファイル名文字列
@param string 書き込む文字列
@param of...

• IO

IO.write(path, string, offset=nil, **opts) -> Integer (18610.0)

• 3.3

• 特異メソッド

path で指定されるファイルを開き、string を書き込み、 閉じます。

path で指定されるファイルを開き、string を書き込み、
閉じます。

Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドを実行し、コマンドの出力を標準出力に書き込みます。

offset を指定するとその位置までシークします。

offset を指定しないと、書き込みの末尾でファイルを
切り捨てます。

キーワード引数はファイルを開くときに使われ、エンコーディングなどを指定することができます。
詳しくは IO.open を見てください。

@param path ファイル名文字列
@param string 書き込む文字列
@param of...

• IO

RubyVM::InstructionSequence.compile_file(file, options = nil) -> RubyVM::InstructionSequence (18610.0)

• 3.3

• 特異メソッド

引数 file で指定した Ruby のソースコードを元にコンパイル済みの RubyVM::InstructionSequence オブジェクトを作成して返します。

引数 file で指定した Ruby のソースコードを元にコンパイル済みの
RubyVM::InstructionSequence オブジェクトを作成して返します。

RubyVM::InstructionSequence.compile とは異なり、file、path などの
メタデータは自動的に取得します。

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

@param options コンパイル時のオプションを true、false、Hash オブ
ジェクトのいずれかで指定します。詳細は
RubyVM::Instr...

• Hash
• RubyVM::InstructionSequence

絞り込み条件を変える

RubyVM::InstructionSequence.of(body) -> RubyVM::InstructionSequence (18610.0)

• 3.3

• 特異メソッド

引数 body で指定した Proc、Method オブジェクトを元に RubyVM::InstructionSequence オブジェクトを作成して返します。

引数 body で指定した Proc、Method オブジェクトを元に
RubyVM::InstructionSequence オブジェクトを作成して返します。

@param body Proc、Method オブジェクトを指定します。

例1:irb で実行した場合

# proc
> p = proc { num = 1 + 2 }
> RubyVM::InstructionSequence.of(p)
> # => <RubyVM::InstructionSequence:block in irb_binding@(irb)>

# method
> def ...

• Method
• Proc
• RubyVM::InstructionSequence

Thread.pending_interrupt?(error = nil) -> bool (18610.0)

• 3.3

• 特異メソッド

非同期割り込みのキューが空かどうかを返します。

非同期割り込みのキューが空かどうかを返します。

Thread.handle_interrupt は非同期割り込みの発生を延期させるのに使
用しますが、本メソッドは任意の非同期割り込みが存在するかどうかを確認す
るのに使用します。

本メソッドが true を返した場合、Thread.handle_interrupt で例外の
発生を延期するブロックを終了すると延期させられていた例外を発生させるこ
とができます。

@param error 対象の例外クラスを指定します。省略した場合は全ての例外を対
象に確認を行います。

例: 延期させられていた例外をただちに発生...

• Thread

main.private(name) -> String | Symbol (18610.0)

• 3.3

• 特異メソッド

メソッドを private に設定します。

メソッドを private に設定します。

引数が与えられた時には引数によって指定されたメソッドを private に
設定します。

引数なしのときは今後このクラスまたはモジュール定義内で新規に定義さ
れるメソッドを関数形式でだけ呼び出せるように(private)設定します。

@param name 0 個以上の String または Symbol を指定します。
@param names 0 個以上の String または Symbol を Array で指定します。

@raise NameError 存在しないメソッド名を指定した場合に発生します。


@see Module#...

• Array
• String
• Symbol
• main

Complex.rect(r, i = 0) -> Complex (18382.0)

• 3.3

• 特異メソッド

実部が r、虚部が i である Complex クラスのオブジェクトを生成します。

実部が r、虚部が i である Complex クラスのオブジェクトを生成します。

@param r 生成する複素数の実部。

@param i 生成する複素数の虚部。省略した場合は 0 です。

//emlist[例][ruby]{
Complex.rect(1) # => (1+0i)
Complex.rect(1, 2) # => (1+2i)
Complex.rectangular(1, 2) # => (1+2i)
//}

@see Kernel.#Complex

• Complex

Complex.rectangular(r, i = 0) -> Complex (18382.0)

• 3.3

• 特異メソッド

実部が r、虚部が i である Complex クラスのオブジェクトを生成します。

実部が r、虚部が i である Complex クラスのオブジェクトを生成します。

@param r 生成する複素数の実部。

@param i 生成する複素数の虚部。省略した場合は 0 です。

//emlist[例][ruby]{
Complex.rect(1) # => (1+0i)
Complex.rect(1, 2) # => (1+2i)
Complex.rectangular(1, 2) # => (1+2i)
//}

@see Kernel.#Complex

• Complex

絞り込み条件を変える

IO.foreach(path, rs = $/, chomp: false) -> Enumerator (18382.0)

• 3.3

• 特異メソッド

path で指定されたファイルの各行を引数としてブロックを繰り返し実行します。 path のオープンに成功すれば nil を返します。

path で指定されたファイルの各行を引数としてブロックを繰り返し実行します。
path のオープンに成功すれば nil を返します。

ブロックが与えられなかった場合は、path で指定されたファイルの各行を繰り返す
Enumerator オブジェクトを生成して返します。

テキスト読み込みメソッドとして動作します。

path が空ファイルの場合、何もせずに nil を返します。
Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドの出力を読み取ります。

@param path ファイル名を表す文字列か "|コマンド名" を指定します。

@pa...

• Enumerator
• IO

IO.foreach(path, rs = $/, chomp: false) {|line| ... } -> nil (18382.0)

• 3.3

• 特異メソッド

path で指定されたファイルの各行を引数としてブロックを繰り返し実行します。 path のオープンに成功すれば nil を返します。

path で指定されたファイルの各行を引数としてブロックを繰り返し実行します。
path のオープンに成功すれば nil を返します。

ブロックが与えられなかった場合は、path で指定されたファイルの各行を繰り返す
Enumerator オブジェクトを生成して返します。

テキスト読み込みメソッドとして動作します。

path が空ファイルの場合、何もせずに nil を返します。
Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドの出力を読み取ります。

@param path ファイル名を表す文字列か "|コマンド名" を指定します。

@pa...

• Enumerator
• IO

Complex.polar(r, theta = 0) -> Complex (18379.0)

• 3.3

• 特異メソッド

絶対値が r、偏角が theta である Complex クラスのオブジェクトを生成します。

絶対値が r、偏角が theta である Complex クラスのオブジェクトを生成します。

@param r 生成する複素数の絶対値。

@param theta 生成する複素数の偏角。単位はラジアンです。省略した場合は 0 です。

//emlist[例][ruby]{
Complex.polar(2.0) # => (2.0+0.0i)
Complex.polar(2.0, 0) # => (2.0+0.0i)
Complex.polar(2.0, Math::PI) # => (-2.0+2.4492127076447545e-16i)
//...

• Complex

IO.for_fd(fd, mode = "r", **opts) -> IO (18358.0)

• 3.3

• 特異メソッド

オープン済みのファイルディスクリプタ fd に対する新しい IO オブジェクトを生成して返します。

オープン済みのファイルディスクリプタ fd に対する新しい
IO オブジェクトを生成して返します。

IO.open にブロックが与えられた場合、IO オブジェクトを生成しそれを引数としてブロックを
実行します。ブロックの終了とともに fd はクローズされます。ブロックの結果を返します。
IO.new, IO.for_fd はブロックを受け付けません。

=== キーワード引数
このメソッドは以下のキーワード引数を利用できます。
* :mode mode引数と同じ意味です
* :external_encoding 外部エンコーディング。"-" はデフォルト外部エンコーディングの
...

• IO

IO.readlines(path, limit, chomp: false, opts={}) -> [String] (18346.0)

• 3.3

• 特異メソッド

path で指定されたファイルを全て読み込んで、その各行を要素としてもつ配列を返します。

path で指定されたファイルを全て読み込んで、その各行を要素としてもつ配列を返します。

Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドの出力を読み取ります。

テキスト読み込みメソッドとして動作します。

limit で最大読み込みバイト数を指定します。ただしマルチバイト文字が途中で
切れないように余分に読み込む場合があります。

opts でファイルを開くときのオプションを指定します。エンコーディングなど
を指定できます。
File.open と同様なのでそちらを参照してください。

@param path ファイル名を表す文字列か "|コ...

• IO

絞り込み条件を変える

IO.readlines(path, rs = $/, chomp: false, opts={}) -> [String] (18346.0)

• 3.3

• 特異メソッド

path で指定されたファイルを全て読み込んで、その各行を要素としてもつ配列を返します。

path で指定されたファイルを全て読み込んで、その各行を要素としてもつ配列を返します。

Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドの出力を読み取ります。

テキスト読み込みメソッドとして動作します。

limit で最大読み込みバイト数を指定します。ただしマルチバイト文字が途中で
切れないように余分に読み込む場合があります。

opts でファイルを開くときのオプションを指定します。エンコーディングなど
を指定できます。
File.open と同様なのでそちらを参照してください。

@param path ファイル名を表す文字列か "|コ...

• IO

IO.readlines(path, rs, limit, chomp: false, opts={}) -> [String] (18346.0)

• 3.3

• 特異メソッド

path で指定されたファイルを全て読み込んで、その各行を要素としてもつ配列を返します。

path で指定されたファイルを全て読み込んで、その各行を要素としてもつ配列を返します。

Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドの出力を読み取ります。

テキスト読み込みメソッドとして動作します。

limit で最大読み込みバイト数を指定します。ただしマルチバイト文字が途中で
切れないように余分に読み込む場合があります。

opts でファイルを開くときのオプションを指定します。エンコーディングなど
を指定できます。
File.open と同様なのでそちらを参照してください。

@param path ファイル名を表す文字列か "|コ...

• IO

Enumerator.produce(initial = nil) { |prev| ... } -> Enumerator (18328.0)

• 3.3

• 特異メソッド

与えられたブロックを呼び出し続ける、停止しない Enumerator を返します。 ブロックの戻り値が、次にブロックを呼び出す時に引数として渡されます。 initial 引数が渡された場合、最初にブロックを呼び出す時にそれがブロック 呼び出しの引数として渡されます。initial が渡されなかった場合は nil が 渡されます。

与えられたブロックを呼び出し続ける、停止しない Enumerator を返します。
ブロックの戻り値が、次にブロックを呼び出す時に引数として渡されます。
initial 引数が渡された場合、最初にブロックを呼び出す時にそれがブロック
呼び出しの引数として渡されます。initial が渡されなかった場合は nil が
渡されます。

ブロックが例外 StopIterationを投げた場合、繰り返しが終了します。

@param initial ブロックに最初に渡される値です。任意のオブジェクトを渡せます。

//emlist[例][ruby]{
# 1, 2, 3, 4, ... と続く En...

• Enumerator
• StopIteration

IO.read(path, **opt) -> String | nil (18328.0)

• 3.3

• 特異メソッド

path で指定されたファイルを offset 位置から length バイト分読み込んで返します。

path で指定されたファイルを offset 位置から
length バイト分読み込んで返します。

既に EOF に達している場合は nil を返します。ただし、length に nil か 0 が指定されている場合は、空文字列 "" を返します。例えば、IO.read(空ファイル) は "" を返します。

引数 length が指定された場合はバイナリ読み込みメソッド、そうでない場合はテキスト読み込みメソッドとして
動作します。

Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドの出力を読み取ります。

@param path ファイル名を...

• IO

IO.read(path, length = nil, **opt) -> String | nil (18328.0)

• 3.3

• 特異メソッド

path で指定されたファイルを offset 位置から length バイト分読み込んで返します。

path で指定されたファイルを offset 位置から
length バイト分読み込んで返します。

既に EOF に達している場合は nil を返します。ただし、length に nil か 0 が指定されている場合は、空文字列 "" を返します。例えば、IO.read(空ファイル) は "" を返します。

引数 length が指定された場合はバイナリ読み込みメソッド、そうでない場合はテキスト読み込みメソッドとして
動作します。

Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドの出力を読み取ります。

@param path ファイル名を...

• IO

絞り込み条件を変える

IO.read(path, length = nil, offset = 0, **opt) -> String | nil (18328.0)

• 3.3

• 特異メソッド

path で指定されたファイルを offset 位置から length バイト分読み込んで返します。

path で指定されたファイルを offset 位置から
length バイト分読み込んで返します。

既に EOF に達している場合は nil を返します。ただし、length に nil か 0 が指定されている場合は、空文字列 "" を返します。例えば、IO.read(空ファイル) は "" を返します。

引数 length が指定された場合はバイナリ読み込みメソッド、そうでない場合はテキスト読み込みメソッドとして
動作します。

Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドの出力を読み取ります。

@param path ファイル名を...

• IO

Array.try_convert(obj) -> Array | nil (18310.0)

• 3.3

• 特異メソッド

to_ary メソッドを用いて obj を配列に変換しようとします。

to_ary メソッドを用いて obj を配列に変換しようとします。

何らかの理由で変換できないときには nil を返します。
このメソッドは引数が配列であるかどうかを調べるために使えます。

//emlist[例][ruby]{
Array.try_convert([1]) # => [1]
Array.try_convert("1") # => nil

if tmp = Array.try_convert(arg)
# the argument is an array
elsif tmp = String.try_convert(arg)
# the argument ...

• Array

Data.members -> [Symbol] (18310.0)

• 3.3

• 特異メソッド

値オブジェクトのメンバの名前(Symbol)の配列を返します。

値オブジェクトのメンバの名前(Symbol)の配列を返します。

//emlist[例][ruby]{
Foo = Data.define(:foo, :bar)
p Foo.members # => [:foo, :bar]
//}

• Data
• Symbol

Dir.chdir -> 0 (18310.0)

• 3.3

• 特異メソッド

カレントディレクトリを path に変更します。

カレントディレクトリを path に変更します。

path を省略した場合、環境変数 HOME または LOGDIR
が設定されていればそのディレクトリに移動します。
カレントディレクトリの変更に成功すれば 0 を返します。

ブロックが指定された場合、カレントディレクトリの変更はブロックの実行中に限
られます。ブロックの実行結果を返します。

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

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

//emlist[例][ruby]{
Dir.chdir("/var/spool/mail")
p Dir.pw...

• Dir

Dir.chdir {|path| ... } -> object (18310.0)

• 3.3

• 特異メソッド

カレントディレクトリを path に変更します。

カレントディレクトリを path に変更します。

path を省略した場合、環境変数 HOME または LOGDIR
が設定されていればそのディレクトリに移動します。
カレントディレクトリの変更に成功すれば 0 を返します。

ブロックが指定された場合、カレントディレクトリの変更はブロックの実行中に限
られます。ブロックの実行結果を返します。

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

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

//emlist[例][ruby]{
Dir.chdir("/var/spool/mail")
p Dir.pw...

• Dir

絞り込み条件を変える

Dir.chdir(path) -> 0 (18310.0)

• 3.3

• 特異メソッド

カレントディレクトリを path に変更します。

カレントディレクトリを path に変更します。

path を省略した場合、環境変数 HOME または LOGDIR
が設定されていればそのディレクトリに移動します。
カレントディレクトリの変更に成功すれば 0 を返します。

ブロックが指定された場合、カレントディレクトリの変更はブロックの実行中に限
られます。ブロックの実行結果を返します。

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

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

//emlist[例][ruby]{
Dir.chdir("/var/spool/mail")
p Dir.pw...

• Dir

Dir.chdir(path) {|path| ... } -> object (18310.0)

• 3.3

• 特異メソッド

カレントディレクトリを path に変更します。

カレントディレクトリを path に変更します。

path を省略した場合、環境変数 HOME または LOGDIR
が設定されていればそのディレクトリに移動します。
カレントディレクトリの変更に成功すれば 0 を返します。

ブロックが指定された場合、カレントディレクトリの変更はブロックの実行中に限
られます。ブロックの実行結果を返します。

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

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

//emlist[例][ruby]{
Dir.chdir("/var/spool/mail")
p Dir.pw...

• Dir

Dir.children(path) -> [String] (18310.0)

• 3.3

• 特異メソッド

ディレクトリ path に含まれるファイルエントリ名のうち、 "." と ".." をのぞいた配列を返します。

ディレクトリ path に含まれるファイルエントリ名のうち、
"." と ".." をのぞいた配列を返します。

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

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

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

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

• Dir

Dir.children(path, encoding: enc) -> [String] (18310.0)

• 3.3

• 特異メソッド

ディレクトリ path に含まれるファイルエントリ名のうち、 "." と ".." をのぞいた配列を返します。

ディレクトリ path に含まれるファイルエントリ名のうち、
"." と ".." をのぞいた配列を返します。

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

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

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

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

• Dir

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

• 3.3

• 特異メソッド

ルートディレクトリを 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.foreach(path) -> Enumerator (18310.0)

• 3.3

• 特異メソッド

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

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

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

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

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

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

//...

• Dir
• Enumerator

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

• 3.3

• 特異メソッド

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

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

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

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

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

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

//...

• Dir
• Enumerator

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

• 3.3

• 特異メソッド

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

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

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

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

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

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

//...

• Dir
• Enumerator

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

• 3.3

• 特異メソッド

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

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

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

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

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

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

//...

• Dir
• Enumerator

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

• 3.3

• 特異メソッド

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.rmdir(path) -> 0 (18310.0)

• 3.3

• 特異メソッド

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

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

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

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

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

• Dir

ENV.clear -> self (18310.0)

• 3.3

• 特異メソッド

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

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

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

• ENV

ENV.filter {|key, value| ... } -> Hash (18310.0)

• 3.3

• 特異メソッド

環境変数名と値についてブロックを評価し、真を返したものを集めたハッシュ を返します。

環境変数名と値についてブロックを評価し、真を返したものを集めたハッシュ
を返します。

• ENV

ENV.filter! -> Enumerator (18310.0)

• 3.3

• 特異メソッド

キーと値を引数としてブロックを評価した結果が真であ るような要素を環境変数に残します。

キーと値を引数としてブロックを評価した結果が真であ
るような要素を環境変数に残します。

keep_if は常に self を返します。
select! と filter! はオブジェクトが変更された場合に self を、
されていない場合に nil を返します。

ブロックが省略された場合には Enumerator を返します。

@see ENV.delete_if,ENV.reject!, Hash#keep_if, Hash#select!,

• ENV
• Enumerator

ENV.filter! {|key, value| ... } -> ENV | nil (18310.0)

• 3.3

• 特異メソッド

キーと値を引数としてブロックを評価した結果が真であ るような要素を環境変数に残します。

キーと値を引数としてブロックを評価した結果が真であ
るような要素を環境変数に残します。

keep_if は常に self を返します。
select! と filter! はオブジェクトが変更された場合に self を、
されていない場合に nil を返します。

ブロックが省略された場合には Enumerator を返します。

@see ENV.delete_if,ENV.reject!, Hash#keep_if, Hash#select!,

• ENV
• Enumerator

絞り込み条件を変える

ENV.freeze -> () (18310.0)

• 3.3

• 特異メソッド

ENV.freeze は環境変数の変更を禁止できないため、TypeErrorを発生させます。

ENV.freeze は環境変数の変更を禁止できないため、TypeErrorを発生させます。

• ENV
• TypeError

ENV.invert -> Hash (18310.0)

• 3.3

• 特異メソッド

環境変数の値をキー、名前を値とした Hash を生成して返します。

環境変数の値をキー、名前を値とした Hash を生成して返します。

• ENV
• Hash

ENV.merge!(*others) -> ENV (18310.0)

• 3.3

• 特異メソッド

ハッシュ others の内容を環境変数にマージします。重複するキー に対応する値は others の内容で上書きされます。

ハッシュ others の内容を環境変数にマージします。重複するキー
に対応する値は others の内容で上書きされます。

self と others に同じキーがあった場合はブロック付きか否かで
判定方法が違います。ブロック付きのときはブロックを呼び出して
その返す値を重複キーに対応する値にします。ブロック付きでない
場合は常に others の値を使います。

@param others マージ用のハッシュです。

• ENV

ENV.merge!(*others) {|key, self_val, other_val| ... } -> ENV (18310.0)

• 3.3

• 特異メソッド

ハッシュ others の内容を環境変数にマージします。重複するキー に対応する値は others の内容で上書きされます。

ハッシュ others の内容を環境変数にマージします。重複するキー
に対応する値は others の内容で上書きされます。

self と others に同じキーがあった場合はブロック付きか否かで
判定方法が違います。ブロック付きのときはブロックを呼び出して
その返す値を重複キーに対応する値にします。ブロック付きでない
場合は常に others の値を使います。

@param others マージ用のハッシュです。

• ENV

ENV.rehash -> nil (18310.0)

• 3.3

• 特異メソッド

何もしません。nilを返します。

何もしません。nilを返します。

• ENV

絞り込み条件を変える

ENV.reject -> Enumerator (18310.0)

• 3.3

• 特異メソッド

環境変数のうち、ブロックを評価した値が真であるものをとり除きます。 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 (18310.0)

• 3.3

• 特異メソッド

環境変数のうち、ブロックを評価した値が真であるものをとり除きます。 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.replace(hash) -> ENV (18310.0)

• 3.3

• 特異メソッド

環境変数を hash と同じ内容に変更します。 self を返します。

環境変数を hash と同じ内容に変更します。 self を返します。

@param hash キーと値の対応関係を指定します。 to_hash でハッシュに変換されます。

• ENV

Encoding.default_external -> Encoding (18310.0)

• 3.3

• 特異メソッド

既定の外部エンコーディングを返します。

既定の外部エンコーディングを返します。

標準入出力、コマンドライン引数、open で開くファイルなどで、外部エンコーディングが指定されていない場合の既定値として利用されます。

Rubyはロケールまたは -E オプションに従って default_external を決定します。ロケールの確認・設定方法については各システムのマニュアルを参照してください。

-E オプションを指定していない場合は、WindowsではUTF-8、その他のOSではロケールに従って default_external を決定します。

default_external は必ず設定されます。Encoding.locale...

• Encoding
• spec/rubycmd

Encoding.default_external=(encoding) (18310.0)

• 3.3

• 特異メソッド

既定の外部エンコーディングを設定します。

既定の外部エンコーディングを設定します。

default_external を変更する前に作成した文字列と、default_external を変更した後に作成した文字列とではエンコーディングが異なる可能性があるため、Ruby スクリプト内で Encoding.default_external を設定してはいけません。代わりに、ruby -E を使用して、正しい default_external で Ruby を起動してください。

デフォルトの外部エンコーディングがどのように使われるかについては Encoding.default_external を参照してください。

@see spec...

• Encoding
• spec/rubycmd

絞り込み条件を変える

Encoding.default_internal -> Encoding | nil (18310.0)

• 3.3

• 特異メソッド

既定の内部エンコーディングを返します。デフォルトでは nil です。

既定の内部エンコーディングを返します。デフォルトでは nil です。

標準入出力、コマンドライン引数、open で開くファイルなどで、内部エンコーディングが指定されていない場合の既定値として利用されます。

String#encode と String#encode! は、引数に Encoding が与えられていない場合、 default_internal を使用します。

文字列リテラルを作成した場合、エンコーディングには default_internal ではなく __ENCODING__ 特殊変数で参照できるスクリプトエンコーディングが使用されます。

default_internal...

• Encoding
• spec/rubycmd

Encoding.default_internal=(encoding) (18310.0)

• 3.3

• 特異メソッド

既定の内部エンコーディングを設定します。

既定の内部エンコーディングを設定します。

default_internal を変更する前に作成した文字列と、default_internal を変更した後に作成した文字列とではエンコーディングが異なる可能性があるため、Ruby スクリプト内で Encoding.default_internal を設定してはいけません。代わりに、ruby -E を使用して、正しい default_internal で Ruby を起動してください。

デフォルトの内部エンコーディングがどのように使われるかについては Encoding.default_internal を参照してください。

@see spe...

• Encoding
• spec/rubycmd

Encoding.locale_charmap -> String | nil (18310.0)

• 3.3

• 特異メソッド

ロケールエンコーディングを決定するために用いる、locale charmap 名を返します。nl_langinfo 等がない環境では nil を、miniruby では ASCII_8BIT を返します。

ロケールエンコーディングを決定するために用いる、locale charmap 名を返します。nl_langinfo 等がない環境では nil を、miniruby では ASCII_8BIT を返します。

//emlist[Debian GNU/Linux + LANG=C][ruby]{
Encoding.locale_charmap #=> "ANSI_X3.4-1968"
//}

//emlist[LANG=ja_JP.EUC-JP][ruby]{
Encoding.locale_charmap #=> "EUC-JP"
//}

//emlist[SunOS 5 + LANG=C]...

• Encoding

Fiber.current -> Fiber (18310.0)

• 3.3

• 特異メソッド

このメソッドが評価されたコンテキストにおける 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

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

• 3.3

• 特異メソッド

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

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

@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.chardev?(path) -> bool (18310.0)

• 3.3

• 特異メソッド

FileTest.#chardev? と同じです。

FileTest.#chardev? と同じです。

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

• File

File.directory?(path) -> bool (18310.0)

• 3.3

• 特異メソッド

FileTest.#directory? と同じです。

FileTest.#directory? と同じです。

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

• File

File.dirname(filename, level=1) -> String (18310.0)

• 3.3

• 特異メソッド

filename の一番後ろのスラッシュより前を文 字列として返します。スラッシュを含まないファイル名に対しては "."(カレントディレクトリ)を返します。

filename の一番後ろのスラッシュより前を文
字列として返します。スラッシュを含まないファイル名に対しては
"."(カレントディレクトリ)を返します。

//emlist[例][ruby]{
p File.dirname("dir/file.ext") # => "dir"
p File.dirname("file.ext") # => "."
//}

File.dirname の動作は dirname(3)
に従います。
//emlist[例][ruby]{
p File.dirname("foo/bar/") # => "foo"
p File.di...

• File

File.executable_real?(path) -> bool (18310.0)

• 3.3

• 特異メソッド

FileTest.#executable_real? と同じです。

FileTest.#executable_real? と同じです。

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

• File

File.grpowned?(path) -> bool (18310.0)

• 3.3

• 特異メソッド

FileTest.#grpowned? と同じです。

FileTest.#grpowned? と同じです。

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

• File

絞り込み条件を変える

File.readable?(path) -> bool (18310.0)

• 3.3

• 特異メソッド

FileTest.#readable? と同じです。

FileTest.#readable? と同じです。

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

• File

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

• 3.3

• 特異メソッド

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

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

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

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

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

• File

File.realdirpath(pathname, basedir = nil) -> String (18310.0)

• 3.3

• 特異メソッド

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

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

pathname の最後のコンポーネントは存在していなくても例外は発生しません。

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

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

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

• File

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

• 3.3

• 特異メソッド

与えられた 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 (18310.0)

• 3.3

• 特異メソッド

ファイルの名前を変更します。ディレクトリが異なる場合には移動も行い ます。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.truncate(path, length) -> 0 (18310.0)

• 3.3

• 特異メソッド

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.world_readable?(path) -> Integer | nil (18310.0)

• 3.3

• 特異メソッド

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

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

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

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

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

• File

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

• 3.3

• 特異メソッド

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

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

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

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

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

• File

File.writable?(path) -> bool (18310.0)

• 3.3

• 特異メソッド

FileTest.#writable? と同じです。

FileTest.#writable? と同じです。

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

• File

File.writable_real?(path) -> bool (18310.0)

• 3.3

• 特異メソッド

FileTest.#writable_real? と同じです。

FileTest.#writable_real? と同じです。

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

• File

絞り込み条件を変える

GC.start(full_mark: true, immediate_sweep: true) -> nil (18310.0)

• 3.3

• 特異メソッド

ガーベージコレクトを開始します。

ガーベージコレクトを開始します。

GC#garbage_collect や ObjectSpace.#garbage_collect と同じ働きをします。
GC.disable により GC が禁止されている場合でもガベージコレクトを開始します。

nil を返します。

@param full_mark マイナー GC を動作させる場合は false を、そうでない場
合は true を指定します。

@param immediate_sweep sweep を遅らせる(Lazy Sweep を行う)場合は false
...

• GC

GC.stress -> bool (18310.0)

• 3.3

• 特異メソッド

GCがストレスモードかどうかを返します。

GCがストレスモードかどうかを返します。

真が設定されている場合は GC を行えるすべての機会に GC を行います。

@see GC.stress=

• GC

GC.stress=(value) (18310.0)

• 3.3

• 特異メソッド

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

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

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

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

• GC

GC.verify_compaction_references(toward: nil, double_heap: nil) -> Hash (18310.0)

• 3.3

• 特異メソッド

コンパクションの参照の一貫性を検証します。

コンパクションの参照の一貫性を検証します。

このメソッドは処理系依存 (CRuby 特有) です。
コンパクション中に移動されたオブジェクトは T_MOVED オブジェクトに置き換えられます。
コンパクション後には T_MOVED を参照するオブジェクトは存在するべきではありません。

この関数は全てのオブジェクトが移動する余地を確保するためにヒープを2倍にして、
全ての移動を確実にするためにヒープをコンパクションして、全ての参照を更新して、
それからフルGCを実行します。
もし T_MOVED への参照をもつオブジェクトがあれば、マークスタックにプッシュされて、
SEGV が起きるでしょ...

• GC

GC::Profiler.clear -> nil (18310.0)

• 3.3

• 特異メソッド

蓄積している GC のプロファイル情報をすべて削除します。

蓄積している GC のプロファイル情報をすべて削除します。

例:
GC::Profiler.enable
GC.start
GC.start
GC::Profiler.report #=> 2 回分の GC のプロファイル情報出力する。
GC::Profiler.clear
GC.start
GC::Profiler.report #=> 1 回分の GC のプロファイル情報出力する。

• GC::Profiler

絞り込み条件を変える

GC::Profiler.raw_data -> [Hash, ...] | nil (18310.0)

• 3.3

• 特異メソッド

GC のプロファイル情報を GC の発生ごとに Hash の配列 (:GC_INVOKE_TIME が早いもの順)で返します。GC::Profiler が有効になっ ていない場合は nil を返します。

GC のプロファイル情報を GC の発生ごとに Hash の配列
(:GC_INVOKE_TIME が早いもの順)で返します。GC::Profiler が有効になっ
ていない場合は nil を返します。

例:

GC::Profiler.enable
GC.start
GC::Profiler.raw_data
# => [
{
:GC_TIME=>1.3000000000000858e-05,
:GC_INVOKE_TIME=>0.010634999999999999,
:HEAP_USE_SIZE=>289640,
...

• GC::Profiler
• Hash

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

• 3.3

• 特異メソッド

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.result -> String (18310.0)

• 3.3

• 特異メソッド

GC のプロファイル情報をフォーマットし、文字列として返します。

GC のプロファイル情報をフォーマットし、文字列として返します。

プロファイル情報は、GC の発生ごとに集計します。
以下は、5 回 GC が発生した場合の実行例です。

$ ruby -e "GC::Profiler.enable; a = Array.new(100000){ 'aa' }; puts GC::Profiler.result"
GC 5 invokes.
Index Invoke Time(sec) Use Size(byte) Total Size(byte) Total Object ...

• GC::Profiler

Hash.ruby2_keywords_hash?(hash) -> bool (18310.0)

• 3.3

• 特異メソッド

Module#ruby2_keywordsやProc#ruby2_keywordsによる ruby2_keywords フラグが設定されているかどうかを返します。

Module#ruby2_keywordsやProc#ruby2_keywordsによる
ruby2_keywords フラグが設定されているかどうかを返します。

このメソッドはデバッグや調査、シリアライゼーションのために本当に必要な場合のために
用意されていて、普通のプログラムで使うことは想定されていません。

ruby 2.7.1 で追加されたため、ruby 2.7.0 では定義されていません。

//emlist[][ruby]{
ruby2_keywords def foo(*args)
Hash.ruby2_keywords_hash?(args.last)
end
foo(...

• Hash

Hash.try_convert(obj) -> Hash | nil (18310.0)

• 3.3

• 特異メソッド

to_hash メソッドを用いて obj をハッシュに変換しようとします。

to_hash メソッドを用いて obj をハッシュに変換しようとします。

何らかの理由で変換できないときには nil を返します。
このメソッドは引数がハッシュであるかどうかを調べるために使えます。

//emlist[][ruby]{
Hash.try_convert({1=>2}) # => {1=>2}
Hash.try_convert("1=>2") # => nil
//}

• Hash

絞り込み条件を変える