バージョン:2.2.0 > クエリ:kernel > ライブラリ:ビルトイン

self が表すフレームを Kernel.#caller と同じ表現にした文字列を返し
ます。

//emlist[例][ruby]{
# foo.rb
class Foo
attr_accessor :locations
def initialize(skip)
@locations = caller_locations(skip)
end
end

Foo.new(0..2).locations.map do |call|
puts call.to_s
end

# => path/to/foo.rb:5:in `initialize'
# path/to/foo...

TracePoint (55.0)

2.2.0

クラス

Kernel.#set_trace_func と同様の機能をオブジェクト指向的な API で提供するクラスです。

Kernel.#set_trace_func と同様の機能をオブジェクト指向的な API で
提供するクラスです。

//emlist[例:例外に関する情報を収集する][ruby]{
trace = TracePoint.new(:raise) do |tp|
p [tp.lineno, tp.event, tp.raised_exception]
end
# => #<TracePoint:0x007f786a452448>

trace.enable
# => false

0 / 0
# => [5, :raise, #<ZeroDivisionError: divided by 0...

UncaughtThrowError#tag -> object (55.0)

2.2.0

インスタンスメソッド

Kernel.#throw に指定した tag を返します。

Kernel.#throw に指定した tag を返します。

//emlist[例:][ruby]{
def do_complicated_things
throw :uncaught_label
end

begin
do_complicated_things
rescue UncaughtThrowError => ex
p ex.tag # => ":uncaught_label"
end
//}

絞り込み条件を変える

UncaughtThrowError#value -> object (55.0)

2.2.0

インスタンスメソッド

Kernel.#throw に指定した value を返します。

Kernel.#throw に指定した value を返します。

//emlist[例][ruby]{
def do_complicated_things
throw :uncaught_label, "uncaught_value"
end

begin
do_complicated_things
rescue UncaughtThrowError => ex
p ex.value # => "uncaught_value"
end
//}

Array#sample -> object | nil (43.0)

2.2.0

インスタンスメソッド

配列の要素を1個(引数を指定した場合は自身の要素数を越えない範囲で n 個) ランダムに選んで返します。

配列の要素を1個(引数を指定した場合は自身の要素数を越えない範囲で n 個)
ランダムに選んで返します。

重複したインデックスは選択されません。そのため、自身がユニークな配列の
場合は返り値もユニークな配列になります。

配列が空の場合、無引数の場合は nil を、個数を指定した場合は空配列を返します。

srand()が有効です。

@param n 取得する要素の数を指定します。自身の要素数(self.length)以上の
値を指定した場合は要素数と同じ数の配列を返します。
整数以外のオブジェクトを指定した場合は to_int メソッドによる暗
...

Array#sample(n) -> Array (43.0)

2.2.0

インスタンスメソッド

配列の要素を1個(引数を指定した場合は自身の要素数を越えない範囲で n 個) ランダムに選んで返します。

Array#sample(n, random: Random) -> Array (43.0)

2.2.0

インスタンスメソッド

配列の要素を1個(引数を指定した場合は自身の要素数を越えない範囲で n 個) ランダムに選んで返します。

Array#sample(random: Random) -> object | nil (43.0)

2.2.0

インスタンスメソッド

配列の要素を1個(引数を指定した場合は自身の要素数を越えない範囲で n 個) ランダムに選んで返します。

絞り込み条件を変える

Array#shuffle! -> self (43.0)

2.2.0

インスタンスメソッド

配列を破壊的にランダムシャッフルします。

配列を破壊的にランダムシャッフルします。

@param random 乱数生成器(主に Random オブジェクト)を指定します。
選択する要素のインデックスを返す rand メソッドに応答する
オブジェクトであれば指定する事ができます。rand メソッド
の引数には Random#rand(max) のように選択可能なイン
デックスの最大値が指定されます。
Kernel.#rand、Random を使用しないオブジェク
ト...

Array#shuffle!(random: Random) -> self (43.0)

2.2.0

インスタンスメソッド

配列を破壊的にランダムシャッフルします。

BasicObject#instance_eval {|obj| ... } -> object (43.0)

2.2.0

インスタンスメソッド

オブジェクトのコンテキストで文字列 expr またはオブジェクト自身をブロックパラメータとするブロックを評価してその結果を返します。

オブジェクトのコンテキストで文字列 expr またはオブジェクト自身をブロックパラメータとするブロックを
評価してその結果を返します。

オブジェクトのコンテキストで評価するとは評価中の self をそのオブジェクトにして実行するということです。
また、文字列 expr やブロック中でメソッドを定義すればそのオブジェクトの特異メソッドが定義されます。

ただし、ローカル変数だけは、文字列 expr の評価では instance_eval の外側のスコープと、ブロックの評価ではそのブロックの外側のスコープと、共有します。

メソッド定義の中で instance_eval でメソッドを定義した場...

BasicObject#instance_eval(expr, filename = "(eval)", lineno = 1) -> object (43.0)

2.2.0

インスタンスメソッド

オブジェクトのコンテキストで文字列 expr またはオブジェクト自身をブロックパラメータとするブロックを評価してその結果を返します。

Binding (43.0)

2.2.0

クラス

ローカル変数のテーブルと self、モジュールのネストなどの情報を保持するオブジェクトのクラスです。

ローカル変数のテーブルと self、モジュールのネストなどの情報を保
持するオブジェクトのクラスです。

組み込み関数 Kernel.#binding と Proc#binding によっ
てのみ生成され、Kernel.#eval の第 2 引数に使用します。
またトップレベルの Binding オブジェクトとして組み込み定数
Object::TOPLEVEL_BINDING が用意されています。

絞り込み条件を変える

File.new(path, mode = "r", perm = 0666) -> File (43.0)

2.2.0

特異メソッド

path で指定されるファイルをオープンし、File オブジェクトを生成して返します。

path で指定されるファイルをオープンし、File オブジェクトを生成して
返します。

path が整数の場合はファイルディスクリプタとして扱い、それに対応する
File オブジェクトを生成して返します。IO.open と同じです。
ブロックを指定して呼び出した場合は、File オブジェクトを引数として
ブロックを実行します。ブロックの実行が終了すると、ファイルは自動的に
クローズされます。ブロックの実行結果を返します。

@param path ファイルを文字列で指定します。整数を指定した場合はファイルディスクリプタとして扱います。

@param mode モードを文字列か定数の論理...

File.open(path, mode = "r", perm = 0666) -> File (43.0)

2.2.0

特異メソッド

path で指定されるファイルをオープンし、File オブジェクトを生成して返します。

File.open(path, mode = "r", perm = 0666) {|file| ... } -> object (43.0)

2.2.0

特異メソッド

path で指定されるファイルをオープンし、File オブジェクトを生成して返します。

IO#print(*arg) -> nil (43.0)

2.2.0

インスタンスメソッド

引数を IO ポートに順に出力します。引数を省略した場合は、$_ を出力します。

引数を IO ポートに順に出力します。引数を省略した場合は、$_ を出力します。

@param arg Kernel.#print と同じです。

@raise IOError 自身が書き込み用にオープンされていなければ発生します。

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

//emlist[例][ruby]{
$stdout.print("This is ", 100, " percent.\n") # => This is 100 percent.
//}

@see Kernel.#print

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

2.2.0

特異メソッド

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

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

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

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

絞り込み条件を変える

IO.new(fd, mode = "r", **opts) -> IO (43.0)

2.2.0

特異メソッド

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

IO.open(fd, mode = "r", **opts) -> IO (43.0)

2.2.0

特異メソッド

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

IO.open(fd, mode = "r", **opts) {|io| ... } -> object (43.0)

2.2.0

特異メソッド

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

Method#owner -> Class | Module (43.0)

2.2.0

インスタンスメソッド

このメソッドが定義されている class か module を返します。

このメソッドが定義されている class か module を返します。

//emlist[例][ruby]{
class Foo
def foo(arg)
"foo called with arg #{arg}"
end
end

m = Foo.new.method(:foo) # => #<Method: Foo#foo>
m.owner # => Foo

m = Foo.new.method(:puts) # => #<Method: Foo(Kernel)#puts>
m.owner # => Kernel
//}

Module#ancestors -> [Class, Module] (43.0)

2.2.0

インスタンスメソッド

クラス、モジュールのスーパークラスとインクルードしているモジュールを優先順位順に配列に格納して返します。

クラス、モジュールのスーパークラスとインクルードしているモジュール
を優先順位順に配列に格納して返します。

//emlist[例][ruby]{
module Foo
end
class Bar
include Foo
end
class Baz < Bar
p ancestors
p included_modules
p superclass
end
# => [Baz, Bar, Foo, Object, Kernel, BasicObject]
# => [Foo, Kernel]
# => Bar
//}

@see Module#included_modules
...

絞り込み条件を変える

Module#class_variables(inherit = true) -> [Symbol] (43.0)

2.2.0

インスタンスメソッド

クラス／モジュールに定義されているクラス変数の名前の配列を返します。

クラス／モジュールに定義されているクラス変数の名前の配列を返します。

@param inherit false を指定しない場合はスーパークラスやインクルードして
いるモジュールのクラス変数を含みます。

//emlist[例][ruby]{
class One
@@var1 = 1
end
class Two < One
@@var2 = 2
end
One.class_variables # => [:@@var1]
Two.class_variables # => [:@@var2, :@@var1]
Two.class_va...

Module#constants(inherit = true) -> [Symbol] (43.0)

2.2.0

インスタンスメソッド

そのモジュール(またはクラス)で定義されている定数名の配列を返します。

そのモジュール(またはクラス)で定義されている定数名の配列を返します。

inherit に真を指定すると
スーパークラスやインクルードしているモジュールの定数も含みます。
Object のサブクラスの場合、Objectやそのスーパークラスで定義されている
定数は含まれません。 Object.constants とすると Object クラスで定義された
定数の配列が得られます。

得られる定数の順序は保証されません。

@param inherit true を指定するとスーパークラスや include したモジュールで
定義された定数が対象にはなります。false を指定し...

Module#include(*mod) -> self (43.0)

2.2.0

インスタンスメソッド

モジュール mod をインクルードします。

モジュール mod をインクルードします。

@param mod Module のインスタンス( Enumerable など)を指定します。

@raise ArgumentError 継承関係が循環してしまうような include を行った場合に発生します。

//emlist[例][ruby]{
module M
end
module M2
include M
end
module M
include M2
end
//}

実行結果:

-:3:in `append_features': cyclic include detected (ArgumentError)
...

Module.constants -> [Symbol] (43.0)

2.2.0

特異メソッド

このメソッドを呼び出した時点で参照可能な定数名の配列を返します。

このメソッドを呼び出した時点で参照可能な定数名の配列を返します。

//emlist[例][ruby]{
class C
FOO = 1
end
p Module.constants # => [:RUBY_PLATFORM, :STDIN, ..., :C, ...]
# 出力中に :FOO は現われない
//}

@see Module#constants, Kernel.#local_variables, Kernel.#global_variables, Object#instance_variables, Module#class_...

Object#freeze -> self (43.0)

2.2.0

インスタンスメソッド

オブジェクトを凍結（内容の変更を禁止）します。

オブジェクトを凍結（内容の変更を禁止）します。

凍結されたオブジェクトの変更は
例外 RuntimeError を発生させます。
いったん凍結されたオブジェクトを元に戻す方法はありません。

凍結されるのはオブジェクトであり、変数ではありません。代入などで変数の指す
オブジェクトが変化してしまうことは freeze では防げません。 freeze が防ぐのは、
`破壊的な操作' と呼ばれるもの一般です。変数への参照自体を凍結したい
場合は、グローバル変数なら Kernel.#trace_var が使えます。

@return self を返します。

//emlist[][ruby]{
a...

絞り込み条件を変える

Object#inspect -> String (43.0)

2.2.0

インスタンスメソッド

オブジェクトを人間が読める形式に変換した文字列を返します。

オブジェクトを人間が読める形式に変換した文字列を返します。

組み込み関数 Kernel.#p は、このメソッドの結果を使用して
オブジェクトを表示します。

//emlist[][ruby]{
[ 1, 2, 3..4, 'five' ].inspect # => "[1, 2, 3..4, \"five\"]"
Time.new.inspect # => "2008-03-08 19:43:39 +0900"
//}

inspect メソッドをオーバーライドしなかった場合、クラス名とインスタンス
変数の名前、値の組を元にした文字列を返します。

//...

Object#instance_variables -> [Symbol] (43.0)

2.2.0

インスタンスメソッド

オブジェクトのインスタンス変数名をシンボルの配列として返します。

オブジェクトのインスタンス変数名をシンボルの配列として返します。

//emlist[][ruby]{
obj = Object.new
obj.instance_eval { @foo, @bar = nil }
p obj.instance_variables

#=> [:@foo, :@bar]
//}

@see Object#instance_variable_get, Kernel.#local_variables, Kernel.#global_variables, Module.constants, Module#constants, Module#class_variabl...

Object::DATA -> File (43.0)

2.2.0

定数

スクリプトの __END__ プログラムの終り以降をアクセスする File オブジェクト。

スクリプトの __END__
プログラムの終り以降をアクセスする File オブジェクト。

d:spec/program#terminateも参照。

ソースファイルの __END__ 以降は解析・実行の対象にならないので
その部分にプログラムが利用するためのデータを書き込んでおくことができます。
DATA 定数はそのデータ部分にアクセスするための File オブジェクトを保持しています。

__END__ を含まないプログラムにおいては DATA は定義されません。

=== 注意

* DATA.rewind で移動する読みとり位置は __END__ 直後ではなく、
...

Proc (43.0)

2.2.0

クラス

ブロックをコンテキスト(ローカル変数のスコープやスタックフレーム)とともにオブジェクト化した手続きオブジェクトです。

ブロックをコンテキスト(ローカル変数のスコープやスタックフ
レーム)とともにオブジェクト化した手続きオブジェクトです。

Proc はローカル変数のスコープを導入しないことを除いて
名前のない関数のように使えます。ダイナミックローカル変数は
Proc ローカルの変数として使えます。

Proc がローカル変数のスコープを保持していることは以下の例で
変数 var を参照できていることからわかります。

//emlist[例][ruby]{
var = 1
$foo = Proc.new { var }
var = 2

def foo
$foo.call
end

p foo ...

Random.rand -> Float (43.0)

2.2.0

特異メソッド

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

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

Random::DEFAULT.rand と同じです。
Random#rand を参照してください。

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

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

@raise Errno::EDOM rand(1..Float::INFINITY) などのように範囲に問題が...

絞り込み条件を変える

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

2.2.0

特異メソッド

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

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

2.2.0

特異メソッド

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

Random::DEFAULT -> Random (43.0)

2.2.0

定数

Ruby 3.0 から非推奨です。代わりに Random クラスオブジェクトを擬似乱数生成器として使用してください。

Ruby 3.0 から非推奨です。代わりに Random クラスオブジェクトを擬似乱数生成器として使用してください。

デフォルトの擬似乱数生成器です。
Random.rand や Kernel.#rand などで使用されます。

@see Random.srand, Kernel.#srand

Rational#convert(*arg) -> Rational (43.0)

2.2.0

インスタンスメソッド

引数を有理数(Rational)に変換した結果を返します。

引数を有理数(Rational)に変換した結果を返します。

@param arg 変換対象のオブジェクトです。

Kernel.#Rational の本体です。

@see Kernel.#Rational

ThreadError (43.0)

2.2.0

クラス

Thread 関連のエラーが起きたときに発生します。

Thread 関連のエラーが起きたときに発生します。

* カレントスレッドを Thread#join しようとしたとき
* Thread#join でデッドロックしそうになったとき
* 終了したスレッドを Thread#wakeup あるいは Thread#run しようとしたとき
* スレッドが一つしかないのに Thread.stop しようとしたとき
* Kernel.#throw がスレッド内で Kernel.#catch されないとき
* スレッドから return しようとしたとき

* イテレータを与えずにスレッドを生成しようとしたとき
* カレン...

絞り込み条件を変える

TracePoint#defined_class -> Class | module (43.0)

2.2.0

インスタンスメソッド

メソッドを定義したクラスかモジュールを返します。

メソッドを定義したクラスかモジュールを返します。

//emlist[例][ruby]{
class C; def foo; end; end
trace = TracePoint.new(:call) do |tp|
p tp.defined_class # => C
end.enable do
C.new.foo
end
//}

メソッドがモジュールで定義されていた場合も(include に関係なく)モジュー
ルを返します。

//emlist[例][ruby]{
module M; def foo; end; end
class C; include M; end;
trac...

ARGF (25.0)

2.2.0

オブジェクト

スクリプトに指定した引数 (Object::ARGV を参照) をファイル名とみなして、それらのファイルを連結した 1 つの仮想ファイルを表すオブジェクトです。 ARGV が空なら標準入力を対象とします。 ARGV を変更すればこのオブジェクトの動作に影響します。

スクリプトに指定した引数
(Object::ARGV を参照) をファイル名とみなして、
それらのファイルを連結した 1 つの仮想ファイルを表すオブジェクトです。
ARGV が空なら標準入力を対象とします。
ARGV を変更すればこのオブジェクトの動作に影響します。

//emlist[][ruby]{
while line = ARGF.gets
# do something
end
//}

は、

//emlist[][ruby]{
while argv = ARGV.shift
File.open(argv) {|file|
while line = file.gets...

ARGF.class#gets(limit) -> String | nil (25.0)

2.2.0

インスタンスメソッド

ARGFの現在位置から一行ずつ文字列として読み込みます。EOF に到達した時には nil を返します。

ARGFの現在位置から一行ずつ文字列として読み込みます。EOF に到達した時に
は nil を返します。

@param rs 行の区切りを文字列で指定します。rs に nil を指定すると行区切
りなしとみなします。空文字列 "" を指定すると連続する改行を行
の区切りとみなします(パラグラフモード)。

@param limit 最大の読み込みバイト数

例:
# $ echo "line1\nline2\nline3\n\nline4\n" > test.txt
# $ ruby test.rb test.txt

# test.r...

ARGF.class#gets(rs = $/) -> String | nil (25.0)

2.2.0

インスタンスメソッド

ARGFの現在位置から一行ずつ文字列として読み込みます。EOF に到達した時には nil を返します。

ARGF.class#gets(rs, limit) -> String | nil (25.0)

2.2.0

インスタンスメソッド

ARGFの現在位置から一行ずつ文字列として読み込みます。EOF に到達した時には nil を返します。

絞り込み条件を変える

ARGF.class#print(*arg) -> nil (25.0)

2.2.0

インスタンスメソッド

引数を順に処理対象のファイルに出力します。

引数を順に処理対象のファイルに出力します。

c:ARGF#inplace時にのみ使用できます。
また $stdout への代入の影響を受けません。
それ以外は Kernel.#print と同じです。

@param arg 出力するオブジェクトを任意個指定します。

ARGF.class#printf(format, *arg) -> nil (25.0)

2.2.0

インスタンスメソッド

C 言語の printf と同じように、format に従い引数を文字列に変換して処理対象のファイルに出力します。

C 言語の printf と同じように、format に従い引数を
文字列に変換して処理対象のファイルに出力します。

c:ARGF#inplace時にのみ使用できます。
また $stdout への代入の影響を受けません。
それ以外は出力先を指定しない形式の Kernel.#printf と同じです。

@param format フォーマット文字列です。
@param arg フォーマットされる引数です。

ARGF.class#putc(ch) -> object (25.0)

2.2.0

インスタンスメソッド

文字 ch を処理対象のファイルに出力します。 ch を返します。

文字 ch を処理対象のファイルに出力します。
ch を返します。

c:ARGF#inplace時にのみ使用できます。
また $stdout への代入の影響を受けません。
それ以外は Kernel.#putc と同じです。

@param ch 出力する文字を String オブジェクトで指定します。

ARGF.class#puts(*arg) -> nil (25.0)

2.2.0

インスタンスメソッド

引数と改行を順番に処理対象のファイルに出力します。引数がなければ改行のみを出力します。

引数と改行を順番に処理対象のファイルに出力します。
引数がなければ改行のみを出力します。

c:ARGF#inplace時にのみ使用できます。
また $stdout への代入の影響を受けません。
それ以外は Kernel.#puts と同じです。

@param arg 出力するオブジェクトを任意個指定します。

ARGF.class#readline(limit) -> String (25.0)

2.2.0

インスタンスメソッド

ARGFの現在位置から一行ずつ文字列として読み込みます。EOF に到達した時には EOFError を発生します。

ARGFの現在位置から一行ずつ文字列として読み込みます。EOF に到達した時に
は EOFError を発生します。

@param rs 行の区切りを文字列で指定します。rs に nil を指定すると行区切
りなしとみなします。空文字列 "" を指定すると連続する改行を行
の区切りとみなします(パラグラフモード)。

@param limit 最大の読み込みバイト数

@raise EOFError EOFに達したら発生する

@see Kernel.#readline, ARGF.class#gets

絞り込み条件を変える

ARGF.class#readline(rs = $/) -> String (25.0)

2.2.0

インスタンスメソッド

ARGFの現在位置から一行ずつ文字列として読み込みます。EOF に到達した時には EOFError を発生します。

ARGF.class#readline(rs, limit) -> String (25.0)

2.2.0

インスタンスメソッド

ARGFの現在位置から一行ずつ文字列として読み込みます。EOF に到達した時には EOFError を発生します。

ARGF.class#readlines(limit) -> Array (25.0)

2.2.0

インスタンスメソッド