検索結果

Object::TRUE -> TrueClass (55024.0)

• 2.7.0

• 定数

非推奨です。代表的な真の値。true と同じ。

非推奨です。代表的な真の値。true と同じ。

この定数は過去との互換性のために提供されています。擬似変数 true を使ってください。

Ruby では false と nil が偽として扱われます。
偽でない値(false でも nil でもない値) は全て真とみなされます。

• Object

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

• 2.7.0

• 特異メソッド

引数 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

NilClass#nil? -> bool (45724.0)

• 2.7.0

• インスタンスメソッド

常に true を返します。

常に true を返します。

//emlist[例][ruby]{
nil.nil? # => true
//}

• NilClass

RubyVM::InstructionSequence.compile(source, file = nil, path = nil, line = 1, options = nil) -> RubyVM::InstructionSequence (28903.0)

• 2.7.0

• 特異メソッド

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

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

@param source Ruby のソースコードを文字列で指定します。

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

@param path 引数 file の絶対パスファイル名を文字列で指定します。

@param line 引数 source の 1 行目の行番号を指定します。

@param options コンパイル時のオプションを true、false、Hash オブ
...

• Hash
• RubyVM::InstructionSequence

Module#ruby2_keywords(method_name, ...) -> nil (28015.0)

• 2.7.0

• インスタンスメソッド

For the given method names, marks the method as passing keywords through a normal argument splat. This should only be called on methods that accept an argument splat (`*args`) but not explicit keywords or a keyword splat. It marks the method such that if the method is called with keyword arguments, the final hash argument is marked with a special flag such that if it is the final element of a normal argument splat to another method call, and that method call does not include explicit keywords or a keyword splat, the final element is interpreted as keywords. In other words, keywords will be passed through the method to other methods.

For the given method names, marks the method as passing keywords through
a normal argument splat. This should only be called on methods that
accept an argument splat (`*args`) but not explicit keywords or a
keyword splat. It marks the method such that if the method is called
with keyword argument...

• Module

絞り込み条件を変える

Readline.#readline(prompt = "", add_hist = false) -> String | nil (27772.0)

• 2.7.0

• モジュール関数

prompt を出力し、ユーザからのキー入力を待ちます。 エンターキーの押下などでユーザが文字列を入力し終えると、 入力した文字列を返します。 このとき、add_hist が true であれば、入力した文字列を入力履歴に追加します。 何も入力していない状態で EOF(UNIX では ^D) を入力するなどで、 ユーザからの入力がない場合は nil を返します。

prompt を出力し、ユーザからのキー入力を待ちます。
エンターキーの押下などでユーザが文字列を入力し終えると、
入力した文字列を返します。
このとき、add_hist が true であれば、入力した文字列を入力履歴に追加します。
何も入力していない状態で EOF(UNIX では ^D) を入力するなどで、
ユーザからの入力がない場合は nil を返します。

本メソッドはスレッドに対応しています。
入力待ち状態のときはスレッドコンテキストの切替えが発生します。

入力時には行内編集が可能で、vi モードと Emacs モードが用意されています。
デフォルトは Emacs モードです。
...

• Readline

RubyVM::InstructionSequence.compile_option=(options) (27391.0)

• 2.7.0

• 特異メソッド

命令シーケンスのコンパイル時のデフォルトの最適化オプションを引数 options で指定します。

命令シーケンスのコンパイル時のデフォルトの最適化オプションを引数
options で指定します。

@param options コンパイル時の最適化オプションを true、false、nil、
Hash のいずれかで指定します。true を指定した場合は
全てのオプションを有効にします。false を指定した場合は全
てのオプションを無効にします。nil を指定した場合はいずれ
のオプションも変更しません。また、Hash を指定した
場合は以...

• RubyVM::InstructionSequence

WIN32OLE_EVENT#handler=(obj) -> () (27355.0)

• 2.7.0

• インスタンスメソッド

イベント処理を実行するオブジェクトを登録します。

イベント処理を実行するオブジェクトを登録します。

イベントハンドラをメソッドとして持つオブジェクトをイベントハンドラとし
て登録します。

イベントハンドラはイベント名に「on」を前置します。もし、イベントに対応
するonメソッドが実装されていなければmethod_missingが呼ばれます。イベン
ト名は大文字小文字を区別するため、正確な記述が必要です。

@param obj イベントに対応するメソッドを持つオブジェクト。イベント受信を
解除するにはnilを指定します。

class IeHandler
def initialize
@com...

• WIN32OLE_EVENT

Ruby用語集 (20746.0)

• 2.7.0

• 文書

Ruby用語集 A　B　C　D　E　F　G　I　J　M　N　O　R　S　Y

Ruby用語集
A　B　C　D　E　F　G　I　J　M　N　O　R　S　Y

a　ka　sa　ta　na　ha　ma　ya　ra　wa

=== 記号・数字
: %記法
: % notation
「%」記号で始まる多種多様なリテラル記法の総称。

参照：d:spec/literal#percent

: 0 オリジン
: zero-based
番号が 0 から始まること。

例えば、
Array や Vector、Matrix などの要素の番号、
String における文字の位置、
といったものは 0 オリジンである。

: 1 オリジン
: one-based
...

• ArgumentError
• Array
• BasicObject
• BigDecimal
• Class
• Comparable
• ENV
• ERB
• Encoding
• Enumerable
• Enumerator
• Exception
• Fiber
• Float
• GC
• Hash
• Integer
• Matrix
• Method
• Module
• ...

GC#garbage_collect(full_mark: true, immediate_sweep: true) -> nil (19618.0)

• 2.7.0

• インスタンスメソッド

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

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

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

nil を返します。

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

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

• GC

絞り込み条件を変える

RubyVM::InstructionSequence.new(source, file = nil, path = nil, line = 1, options = nil) -> RubyVM::InstructionSequence (19603.0)

• 2.7.0

• 特異メソッド

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

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

@param source Ruby のソースコードを文字列で指定します。

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

@param path 引数 file の絶対パスファイル名を文字列で指定します。

@param line 引数 source の 1 行目の行番号を指定します。

@param options コンパイル時のオプションを true、false、Hash オブ
...

• Hash
• RubyVM::InstructionSequence

ObjectSpace.#garbage_collect(full_mark: true, immediate_sweep: true) -> nil (19582.0)

• 2.7.0

• モジュール関数

どこからも参照されなくなったオブジェクトを回収します。 GC.start と同じです。

どこからも参照されなくなったオブジェクトを回収します。
GC.start と同じです。

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

@param immediate_sweep sweep を遅らせる(Lazy Sweep を行う)場合は false
を、そうでない場合は true を指定します。

注意: これらのキーワード引数は Ruby の実装やバージョンによって異なりま
す。将来のバージョンとの互換性も保証されませ...

• ObjectSpace

FileUtils.#cp_lr(src, dest, noop: nil, verbose: nil, dereference_root: true, remove_destination: false) (19408.0)

• 2.7.0

• モジュール関数

src へのハードリンク dest を作成します。 src がディレクトリの場合、再帰的にリンクします。 dest がディレクトリの場合、src へのハードリンク dest/src を作成します。

src へのハードリンク dest を作成します。
src がディレクトリの場合、再帰的にリンクします。
dest がディレクトリの場合、src へのハードリンク dest/src を作成します。

@param src リンク元。一つの場合は文字列でも指定可能です。
二つ以上指定する場合は配列で指定します。

@param dest リンク作成先のファイルかディレクトリです。

@param options :noop, :verbose, :dereference_root, :remove_destination が指定できます。
c...

• FileUtils

Kernel.#Float(arg, exception: true) -> Float | nil (19297.0)

• 2.7.0

• モジュール関数

引数を浮動小数点数(Float)に変換した結果を返します。

引数を浮動小数点数(Float)に変換した結果を返します。

引数が数値の場合は素直に変換し、文字列の場合
は整数や浮動小数点数と見なせるもののみ変換します。

メソッド Float は文字列に対し String#to_f よりも厳密な変換を行います。

@param arg 変換対象のオブジェクトです。
@param exception false を指定すると、変換できなかった場合、
例外を発生する代わりに nil を返します。
@raise ArgumentError 整数や浮動小数点数と見なせない文字列を引数に指定した場合に発生します。
@raise...

• Float
• Kernel

Logger#log(severity, message = nil, progname = nil) -> true (19291.0)

• 2.7.0

• インスタンスメソッド

メッセージをログに記録します。

メッセージをログに記録します。

ブロックを与えた場合はブロックを評価した返り値をメッセージとしてログに記録します。
ユーザがこのメソッドを直接使うことはあまりありません。

@param severity ログレベル。Logger クラスで定義されている定数を指定します。
この値がレシーバーに設定されているレベルよりも低い場合、
メッセージは記録されません。

@param message ログに出力するメッセージを文字列か例外オブジェクトを指定します。
省略すると nil が用いられます。

@...

• Logger

絞り込み条件を変える

Logger#log(severity, message = nil, progname = nil) { ... } -> true (19291.0)

• 2.7.0

• インスタンスメソッド

メッセージをログに記録します。

メッセージをログに記録します。

ブロックを与えた場合はブロックを評価した返り値をメッセージとしてログに記録します。
ユーザがこのメソッドを直接使うことはあまりありません。

@param severity ログレベル。Logger クラスで定義されている定数を指定します。
この値がレシーバーに設定されているレベルよりも低い場合、
メッセージは記録されません。

@param message ログに出力するメッセージを文字列か例外オブジェクトを指定します。
省略すると nil が用いられます。

@...

• Logger

Kernel.#Complex(r, i = 0, exception: true) -> Complex | nil (19267.0)

• 2.7.0

• モジュール関数

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

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

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

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

@param s 生成する複素数を表す文字列。

@param exception false を指定すると、変換できなかった場合、
例外を発生する代わりに nil を返します。

@raise ArgumentError 変換できないオブジェクトを指定した場合に発生します。

//emlist[例][ruby]{
Complex(1) # => (...

• Complex
• Kernel

Kernel.#Complex(s, exception: true) -> Complex | nil (19267.0)

• 2.7.0

• モジュール関数

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

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

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

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

@param s 生成する複素数を表す文字列。

@param exception false を指定すると、変換できなかった場合、
例外を発生する代わりに nil を返します。

@raise ArgumentError 変換できないオブジェクトを指定した場合に発生します。

//emlist[例][ruby]{
Complex(1) # => (...

• Complex
• Kernel

Coverage.result(stop: true, clear: true) -> Hash (19213.0)

• 2.7.0

• 特異メソッド

対象ファイル名をキー、測定結果を値したハッシュを返します。 測定結果の詳細は、coverage ライブラリ を参照してください。

対象ファイル名をキー、測定結果を値したハッシュを返します。
測定結果の詳細は、coverage ライブラリ を参照してください。

@param stop true であれば、カバレッジの測定を終了します。
@param clear true であれば、測定記録をクリアします。

@return 測定結果を表すハッシュ

@raise RuntimeError Coverage.start を実行する前に実行された場合に
発生します。

//emlist[bool.rb][ruby]{
def bool(obj)
if obj
true
...

• Coverage
• coverage

Psych.safe_load(yaml, permitted_classes: [], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false) -> object (19174.0)

• 2.7.0

• 特異メソッド

安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。

安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。

デフォルトでは以下のクラスのオブジェクトしか変換しません。

* TrueClass
* FalseClass
* NilClass
* Numeric
* String
* Array
* Hash

再帰的なデータ構造はデフォルトでは許可されていません。

任意のクラスを許可するにはキーワード引数 permitted_classes を指定すると、
そのクラスが追加されます。例えば Date クラスを許可するには
以下のように書いてください:

//emlist[permitte...

• Psych
• Psych::SyntaxError
• Symbol

絞り込み条件を変える

Marshal フォーマット (19063.0)

• 2.7.0

• 文書

Marshal フォーマット フォーマットバージョン 4.8 を元に記述しています。

Marshal フォーマット
フォーマットバージョン 4.8 を元に記述しています。

=== nil, true, false

それぞれ、'0', 'T', 'F' になります。

//emlist[][ruby]{
p Marshal.dump(nil).unpack1("x2 a*") # => "0"
p Marshal.dump(true).unpack1("x2 a*") # => "T"
p Marshal.dump(false).unpack1("x2 a*") # => "F"
//}

Ruby 2.1 以前では、インスタンス変数を設定しても dump されません...

Rubyの起動 (19036.0)

• 2.7.0

• 文書

Rubyの起動 * cmd_option * shebang

Rubyの起動
* cmd_option
* shebang

Rubyインタプリタの起動は以下の書式のコマンドラインにより行います。

ruby [ option ...] [ -- ] [ programfile ] [ argument ...]

ここで、option は後述のcmd_option
のいずれかを指定します。-- は、オプション列の終りを明示するため
に使用できます。programfile は、Ruby スクリプトを記述したファイ
ルです。これを省略したり`-' を指定した場合には標準入力を Ruby ス
クリプトとみなします。

programfile が...

• platform/Win32

Kernel.#Rational(x, y = 1, exception: true) -> Rational | nil (19033.0)

• 2.7.0

• モジュール関数

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

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

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

@param y 変換対象のオブジェクトです。省略した場合は x だけを用いて
Rational オブジェクトを作成します。

@param exception false を指定すると、変換できなかった場合、
例外を発生する代わりに nil を返します。

@raise ArgumentError 変換できないオブジェクトを指定した場合に発生します。

引数 x、y の両方を指定した場合、x/y した Rational オブジェ...

• ArgumentError
• Kernel
• Rational

Kernel.#BigDecimal(s, exception: true) -> BigDecimal | nil (18949.0)

• 2.7.0

• モジュール関数

引数で指定した値を表す BigDecimal オブジェクトを生成します。

引数で指定した値を表す BigDecimal オブジェクトを生成します。

@param s 数値を表現する初期値を文字列、Integer、
Float、Rational、BigDecimal オブジェクトのい
ずれかで指定します。
文字列中のスペースは無視されます。また、判断できない文字が出現
した時点で文字列は終了したものとみなされます。

@param n 必要な有効桁数(self の最大有効桁数)を整数で指定します。 n が
0 または省略されたときは、n の値は s の有効桁数とみなされます。...

• Float
• Integer
• Kernel

Kernel.#BigDecimal(s, n, exception: true) -> BigDecimal | nil (18949.0)

• 2.7.0

• モジュール関数

引数で指定した値を表す BigDecimal オブジェクトを生成します。

引数で指定した値を表す BigDecimal オブジェクトを生成します。

@param s 数値を表現する初期値を文字列、Integer、
Float、Rational、BigDecimal オブジェクトのい
ずれかで指定します。
文字列中のスペースは無視されます。また、判断できない文字が出現
した時点で文字列は終了したものとみなされます。

@param n 必要な有効桁数(self の最大有効桁数)を整数で指定します。 n が
0 または省略されたときは、n の値は s の有効桁数とみなされます。...

• Float
• Integer
• Kernel

絞り込み条件を変える

Kernel#create_makefile(target, srcprefix = nil) -> true (18943.0)

• 2.7.0

• インスタンスメソッド

@todo

@todo

Kernel#have_library などの各種検査の結果を元に、拡張ライブラリを
ビルドするための Makefile を生成します。

extconf.rb は普通このメソッドの呼び出しで終ります。

@param target ターゲットとなる拡張ライブラリの名前を指定します。
例えば、拡張ライブラリで "Init_foo" という関数を定義して
いる場合は、"foo" を指定します。
'/' を含む場合は、最後のスラッシュ以降のみをターゲット名
として使用します...

• Kernel

Logger#fatal(progname = nil) -> true (18931.0)

• 2.7.0

• インスタンスメソッド

FATAL 情報を出力します。

FATAL 情報を出力します。

ブロックを与えなかった場合は、progname をメッセージとしてログを出力します。

ブロックを与えた場合は、ブロックを評価した結果をメッセージとして
ログを出力します。

引数とブロックを同時に与えた場合は、progname をプログラム名、ブロックを評価した
結果をメッセージとしてログを出力します。

@param progname ブロックを与えない場合は、メッセージとして文字列または例外オブジェクトを指定します。
ブロックを与えた場合は、プログラム名を文字列として与えます。

//emlist[例][ruby]{
r...

• Logger

Logger#fatal(progname = nil) { ... } -> true (18931.0)

• 2.7.0

• インスタンスメソッド

FATAL 情報を出力します。

FATAL 情報を出力します。

ブロックを与えなかった場合は、progname をメッセージとしてログを出力します。

ブロックを与えた場合は、ブロックを評価した結果をメッセージとして
ログを出力します。

引数とブロックを同時に与えた場合は、progname をプログラム名、ブロックを評価した
結果をメッセージとしてログを出力します。

@param progname ブロックを与えない場合は、メッセージとして文字列または例外オブジェクトを指定します。
ブロックを与えた場合は、プログラム名を文字列として与えます。

//emlist[例][ruby]{
r...

• Logger

Psych.safe_load(yaml, legacy_permitted_classes=[], legacy_permitted_symbols=[], legacy_aliases=false, legacy_filename=nil) -> object (18874.0)

• 2.7.0

• 特異メソッド

安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。

安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。

デフォルトでは以下のクラスのオブジェクトしか変換しません。

* TrueClass
* FalseClass
* NilClass
* Numeric
* String
* Array
* Hash

再帰的なデータ構造はデフォルトでは許可されていません。

任意のクラスを許可するにはキーワード引数 permitted_classes を指定すると、
そのクラスが追加されます。例えば Date クラスを許可するには
以下のように書いてください:

//emlist[permitte...

• Psych
• Psych::SyntaxError
• Symbol

TrueClass#|(other) -> bool (18817.0)

• 2.7.0

• インスタンスメソッド

常に true を返します。

常に true を返します。

@param other 論理和を行なう式です。

| は再定義可能な演算子に分類されていますので、通常は true | other のように使われます。

//emlist[例][ruby]{
p true | true #=> true
p true | false #=> true
p true | nil #=> true
p true | (1 == 1) #=> true
p true | (1 + 1) #=> true

p true.|(true) #=> true
p true.|(false) #=> ...

• TrueClass

絞り込み条件を変える

ObjectSpace.#reachable_objects_from(obj) -> Array | nil (18796.0)

• 2.7.0

• モジュール関数

obj から到達可能なすべてのオブジェクトを返します。マーク不能なオブジェ クトを指定した場合は nil を返します。本メソッドを使う事でメモリリークの 調査が行えます。

obj から到達可能なすべてのオブジェクトを返します。マーク不能なオブジェ
クトを指定した場合は nil を返します。本メソッドを使う事でメモリリークの
調査が行えます。

//emlist[例][ruby]{
# 配列クラス(Array)と 'a'、'b'、'c' に到達可能。
ObjectSpace.reachable_objects_from(['a', 'b', 'c'])
# => [Array, 'a', 'b', 'c']
//}

obj が 2 つ以上の同じオブジェクト x への参照を持つ場合、戻り値に含まれ
るオブジェクト x は 1 つだけです。

//emlist[例...

• Fixnum
• Float
• ObjectSpace
• Symbol

Kernel.#caller(range) -> [String] | nil (18754.0)

• 2.7.0

• モジュール関数

start 段上の呼び出し元の情報を $@ の形式のバックトレース(文字列の配列)として返します。

start 段上の呼び出し元の情報を $@
の形式のバックトレース(文字列の配列)として返します。

トップレベルでは空の配列を返します。caller の戻り値を $@ に代入することで
例外の発生位置を設定できます。

引数で指定した値が範囲外の場合は nil を返します。

@param start long の範囲を超えない正の整数でスタックレベルを指定します。
@param length 取得するスタックの個数を指定します。

@param range 取得したいスタックの範囲を示す Range オブジェクトを指定します。

@see Kernel.#set_trace_func,K...

• Kernel
• Range

Kernel.#caller(start = 1) -> [String] | nil (18754.0)

• 2.7.0

• モジュール関数

start 段上の呼び出し元の情報を $@ の形式のバックトレース(文字列の配列)として返します。

start 段上の呼び出し元の情報を $@
の形式のバックトレース(文字列の配列)として返します。

トップレベルでは空の配列を返します。caller の戻り値を $@ に代入することで
例外の発生位置を設定できます。

引数で指定した値が範囲外の場合は nil を返します。

@param start long の範囲を超えない正の整数でスタックレベルを指定します。
@param length 取得するスタックの個数を指定します。

@param range 取得したいスタックの範囲を示す Range オブジェクトを指定します。

@see Kernel.#set_trace_func,K...

• Kernel
• Range

Kernel.#caller(start, length) -> [String] | nil (18754.0)

• 2.7.0

• モジュール関数

start 段上の呼び出し元の情報を $@ の形式のバックトレース(文字列の配列)として返します。

start 段上の呼び出し元の情報を $@
の形式のバックトレース(文字列の配列)として返します。

トップレベルでは空の配列を返します。caller の戻り値を $@ に代入することで
例外の発生位置を設定できます。

引数で指定した値が範囲外の場合は nil を返します。

@param start long の範囲を超えない正の整数でスタックレベルを指定します。
@param length 取得するスタックの個数を指定します。

@param range 取得したいスタックの範囲を示す Range オブジェクトを指定します。

@see Kernel.#set_trace_func,K...

• Kernel
• Range

Psych.load(yaml, filename = nil, fallback: false, symbolize_names: false) -> object (18745.0)

• 2.7.0

• 特異メソッド

YAML ドキュメントを Ruby のデータ構造(オブジェクト)に変換します。

YAML ドキュメントを Ruby のデータ構造(オブジェクト)に変換します。

入力に複数のドキュメントが含まれている場合は、先頭のものを変換して
返します。

filename はパース中に発生した例外のメッセージに用います。


@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@param fallback 引数 yaml に空のYAMLを指定した場合の戻り値を指定します。デフォルトは false です。
@param symbolize_...

• Psych
• Psych::SyntaxError
• Symbol

絞り込み条件を変える

Psych.load(yaml, filename: nil, fallback: false, symbolize_names: false) -> object (18745.0)

• 2.7.0

• 特異メソッド

YAML ドキュメントを Ruby のデータ構造(オブジェクト)に変換します。

YAML ドキュメントを Ruby のデータ構造(オブジェクト)に変換します。

入力に複数のドキュメントが含まれている場合は、先頭のものを変換して
返します。

filename はパース中に発生した例外のメッセージに用います。


@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@param fallback 引数 yaml に空のYAMLを指定した場合の戻り値を指定します。デフォルトは false です。
@param symbolize_...

• Psych
• Psych::SyntaxError
• Symbol

String#lines(rs = $/, chomp: false) {|line| ... } -> self (18745.0)

• 2.7.0

• インスタンスメソッド

文字列中の各行を文字列の配列で返します。(self.each_line.to_a と同じです)

文字列中の各行を文字列の配列で返します。(self.each_line.to_a と同じです)

//emlist[][ruby]{
"aa\nbb\ncc\n".lines # => ["aa\n", "bb\n", "cc\n"]
//}

行の区切りは rs に指定した文字列で、 そのデフォルト値は変数 $/ の値です。
各 line には区切りの文字列も含みます。

rs に nil を指定すると行区切りなしとみなします。 rs に空文字列 "" を指
定すると「パラグラフモード」になり、 改行コードが 2 つ以上連続するとこ
ろで文字列を分割します (つまり空行で分割します)。

...

• String

TrueClass#&(other) -> bool (18745.0)

• 2.7.0

• インスタンスメソッド

other が真なら true を, 偽なら false を返します。

other が真なら true を, 偽なら false を返します。

@param other 論理積を行なう式です。

& は再定義可能な演算子に分類されていますので、通常は true & other のように使われます。

//emlist[例][ruby]{
p true & true #=> true
p true & false #=> false
p true & nil #=> false
p true & (1 == 1) #=> true
p true & (1 + 1) #=> true

p true.&(true) #=> true...

• TrueClass

IO#readlines(limit, chomp: false) -> [String] (18727.0)

• 2.7.0

• インスタンスメソッド

データを全て読み込んで、その各行を要素としてもつ配列を返します。 既に EOF に達していれば空配列 [] を返します。

データを全て読み込んで、その各行を要素としてもつ配列を返します。
既に EOF に達していれば空配列 [] を返します。

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

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

@param rs 行の区切りを文字列で指定します。rs に nil を指定すると行区切りなしとみなします。
空文字列 "" を指定すると連続する改行を行の区切りとみなします(パラグラフモード)。
@param limit 最大の読み込みバイト数
@param chomp tru...

• IO

IO#readlines(rs, limit, chomp: false) -> [String] (18727.0)

• 2.7.0

• インスタンスメソッド

データを全て読み込んで、その各行を要素としてもつ配列を返します。 既に EOF に達していれば空配列 [] を返します。

データを全て読み込んで、その各行を要素としてもつ配列を返します。
既に EOF に達していれば空配列 [] を返します。

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

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

@param rs 行の区切りを文字列で指定します。rs に nil を指定すると行区切りなしとみなします。
空文字列 "" を指定すると連続する改行を行の区切りとみなします(パラグラフモード)。
@param limit 最大の読み込みバイト数
@param chomp tru...

• IO

絞り込み条件を変える

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

• 2.7.0

• 特異メソッド

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

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

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

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

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

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

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

• IO

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

• 2.7.0

• 特異メソッド

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

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

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

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

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

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

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

• IO

OptionParser#load(filename = nil) -> bool (18712.0)

• 2.7.0

• インスタンスメソッド

指定された filename を読み込んで各行をまとめたものに対して OptionParser#parse を行ないます。

指定された filename を読み込んで各行をまとめたものに対して OptionParser#parse を行ないます。

パースが成功した場合に true を返します。
ファイルが存在しなかった場合に false を返します。

@param filename 各行をパースしたいファイルの名前を文字列で指定します。
指定されないか nil である場合、~/.options/ に
プログラムのサフィックスを付けた '~/.options/コマンド名' というファイルをパースします。

//emlist[例][ruby]{
re...

• OptionParser

TrueClass#^(other) -> bool (18709.0)

• 2.7.0

• インスタンスメソッド

other が真なら false を, 偽なら true を返します。

other が真なら false を, 偽なら true を返します。

@param other 排他的論理和を行なう式です。

^ は再定義可能な演算子に分類されていますので、通常は true ^ other のように使われます。

//emlist[例][ruby]{
p true ^ true #=> false
p true ^ false #=> true
p true ^ nil #=> true
p true ^ (1 == 1) #=> false
p true ^ (1 + 1) #=> false

p true.^(true) #=> ...

• TrueClass

Hash#filter! {|key, value| ... } -> self | nil (18697.0)

• 2.7.0

• インスタンスメソッド

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

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

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

ブロックが与えられなかった場合は、自身と keep_if から生成した
Enumerator オブジェクトを返します。

//emlist[例][ruby]{
h1 = {}
c = ("a".."g")
c.each_with_index {|e, i| h1[i] = e }

h2 = h1.dup
h1.select!...

• Enumerator
• Hash

絞り込み条件を変える

Hash#select! {|key, value| ... } -> self | nil (18697.0)

• 2.7.0

• インスタンスメソッド

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

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

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

ブロックが与えられなかった場合は、自身と keep_if から生成した
Enumerator オブジェクトを返します。

//emlist[例][ruby]{
h1 = {}
c = ("a".."g")
c.each_with_index {|e, i| h1[i] = e }

h2 = h1.dup
h1.select!...

• Enumerator
• Hash

JSON::Generator::GeneratorMethods::TrueClass#to_json(state_or_hash = nil) -> String (18676.0)

• 2.7.0

• インスタンスメソッド

自身から生成した JSON 形式の文字列を返します。

自身から生成した JSON 形式の文字列を返します。

"true" という文字列を返します。

@param state_or_hash 生成する JSON 形式の文字列をカスタマイズするため
に JSON::State のインスタンスか、
JSON::State.new の引数と同じ Hash を
指定します。

//emlist[例][ruby]{
require "json"

true.to_json # => "true"
//}

• JSON::Generator::GeneratorMethods::TrueClass

Module#const_source_location(name, inherited = true) -> [String, Integer] (18676.0)

• 2.7.0

• インスタンスメソッド

name で指定した定数の定義を含むソースコードのファイル名と行番号を配列で返します。

name で指定した定数の定義を含むソースコードのファイル名と行番号を配列で返します。

@param name Symbol,String で定数の名前を指定します。
@param inherited true を指定するとスーパークラスや include したモジュールで定義された定数が対象にはなります。false を指定した場合 対象にはなりません。
@return ソースコードのファイル名と行番号を配列で返します。
指定した定数が見つからない場合は nil を返します。
定数は見つかったがソースファイルが見つからなかった場合は空の配列を返します。

...

• Module
• String
• Symbol

IRB::Context#use_readline -> bool | nil (18661.0)

• 2.7.0

• インスタンスメソッド

readline を使うかどうかを返します。

readline を使うかどうかを返します。

@return 戻り値よって以下のように動作します。

: true
readline ライブラリを使う
: false
readline ライブラリを使わない
: nil
inf-ruby-mode 以外で readline ライブラリを利用しようとする (デフォルト)

動作を変更するためには .irbrc ファイル中で IRB.conf[:USE_READLINE] の設
定や irb 起動時に --readline オプション、--noreadline オプションの指定
を行います。

• IRB::Context
• readline

IRB::Context#use_readline? -> bool | nil (18661.0)

• 2.7.0

• インスタンスメソッド

readline を使うかどうかを返します。

readline を使うかどうかを返します。

@return 戻り値よって以下のように動作します。

: true
readline ライブラリを使う
: false
readline ライブラリを使わない
: nil
inf-ruby-mode 以外で readline ライブラリを利用しようとする (デフォルト)

動作を変更するためには .irbrc ファイル中で IRB.conf[:USE_READLINE] の設
定や irb 起動時に --readline オプション、--noreadline オプションの指定
を行います。

• IRB::Context
• readline

絞り込み条件を変える

String#each_line(rs = $/, chomp: false) {|line| ... } -> self (18655.0)

• 2.7.0

• インスタンスメソッド

文字列中の各行に対して繰り返します。 行の区切りは rs に指定した文字列で、 そのデフォルト値は変数 $/ の値です。 各 line には区切りの文字列も含みます。

文字列中の各行に対して繰り返します。
行の区切りは rs に指定した文字列で、
そのデフォルト値は変数 $/ の値です。
各 line には区切りの文字列も含みます。

rs に nil を指定すると行区切りなしとみなします。
rs に空文字列 "" を指定すると「パラグラフモード」になり、
改行コードが 2 つ以上連続するところで文字列を分割します
(つまり空行で分割します)。

@param rs 行末を示す文字列
@param chomp true を指定すると各行の末尾から rs を取り除きます。

//emlist[例][ruby]{
"aa\nbb\ncc\n".each_...

• String

StringScanner#scan_full(regexp, s, f) -> object (18589.0)

• 2.7.0

• インスタンスメソッド

スキャンポインタの位置から regexp と文字列のマッチを試します。

スキャンポインタの位置から regexp と文字列のマッチを試します。

マッチに成功すると、s と f の値によって以下のように動作します。

* s が true ならばスキャンポインタを進めます。
* s が false ならばスキャンポインタを進めません。
* f が true ならばマッチした部分文字列を返します。
* f が false ならばマッチした部分文字列の長さを返します。

マッチに失敗すると s や f に関係なく nil を返します。

このメソッドは s と f の組み合わせにより、
他のメソッドと同等の動作になります。

*...

• StringScanner

StringScanner#search_full(regexp, s, f) -> object (18571.0)

• 2.7.0

• インスタンスメソッド

regexp で指定された正規表現とマッチするまで文字列をスキャンします。

regexp で指定された正規表現とマッチするまで文字列をスキャンします。

マッチに成功すると、s と f の値によって以下のように動作します。

* s が true ならばスキャンポインタを進めます。
* s が false ならばスキャンポインタを進めません。
* f が true ならばスキャン開始位置からマッチした部分の末尾までの部分文字列を返します。
* f が false ならばスキャン開始位置からマッチした部分の末尾までの部分文字列の長さを返します。

マッチに失敗すると s や f に関係なく nil を返します。

このメソッドは s と ...

• StringScanner

Proc#lambda? -> bool (18565.0)

• 2.7.0

• インスタンスメソッド

手続きオブジェクトの引数の取扱が厳密であるならば true を返します。

手続きオブジェクトの引数の取扱が厳密であるならば true を返します。


引数の取扱の厳密さの意味は以下の例を参考にしてください。

//emlist[例][ruby]{
# lambda で生成した Proc オブジェクトでは true
lambda{}.lambda? # => true
# proc で生成した Proc オブジェクトでは false
proc{}.lambda? # => false
# Proc.new で生成した Proc オブジェクトでは false
Proc.new{}.lambda? # => false

# 以下、lambda?が偽である場合
#...

• Proc

Kernel.#lambda { ... } -> Proc (18553.0)

• 2.7.0

• モジュール関数

与えられたブロックから手続きオブジェクト (Proc のインスタンス) を生成して返します。Proc.new に近い働きをします。

与えられたブロックから手続きオブジェクト (Proc のインスタンス)
を生成して返します。Proc.new に近い働きをします。

ブロックが指定されなければ、呼び出し元のメソッドで指定されたブロック
を手続きオブジェクトとして返します。呼び出し元のメソッドがブロックなし
で呼ばれると ArgumentError 例外が発生します。

ただし、ブロックを指定しない呼び出しは推奨されていません。呼び出し元のメソッドで指定されたブロック
を得たい場合は明示的に & 引数でうけるべきです。

ブロックを指定しない lambda は Ruby 2.6 までは警告メッセージ
「warning: tr...

• ArgumentError
• Kernel
• LocalJumpError
• Proc

絞り込み条件を変える

Coverage.peek_result -> Hash (18535.0)

• 2.7.0

• 特異メソッド

測定を止めることなく、測定中のその時の結果をハッシュで返します。 測定結果の詳細は、coverage ライブラリ を参照してください。

測定を止めることなく、測定中のその時の結果をハッシュで返します。
測定結果の詳細は、coverage ライブラリ を参照してください。

これは、Coverage.result(stop: false, clear: false) と同じです。

@return 測定途中結果を表すハッシュ

@raise RuntimeError Coverage.start を実行する前に実行された場合に
発生します。

//emlist[bool.rb][ruby]{
def bool(obj)
if obj
true
else
false...

• Coverage
• coverage

NilClass#^(other) -> bool (18511.0)

• 2.7.0

• インスタンスメソッド

other が真なら true を, 偽なら false を返します。

other が真なら true を, 偽なら false を返します。

@param other 排他的論理和を行なう式です

//emlist[例][ruby]{
nil ^ true # => true
nil ^ false # => false
nil ^ nil # => false
nil ^ "a" # => true
//}

• NilClass

NilClass#|(other) -> bool (18511.0)

• 2.7.0

• インスタンスメソッド

other が真なら true を, 偽なら false を返します。

other が真なら true を, 偽なら false を返します。

@param other 論理和を行なう式です

//emlist[例][ruby]{
nil | true # => true
nil | false # => false
nil | nil # => false
nil | "a" # => true
//}

• NilClass

IO#closed? -> bool (18457.0)

• 2.7.0

• インスタンスメソッド

self が完全に(読み込み用と書き込み用の両方が)クローズされている場合に true を返します。 そうでない場合は false を返します。

self が完全に(読み込み用と書き込み用の両方が)クローズされている場合に true を返します。
そうでない場合は false を返します。

//emlist[例][ruby]{
IO.write("testfile", "test")
f = File.new("testfile")
f.close # => nil
f.closed? # => true
f = IO.popen("/bin/sh","r+")
f.close_write # => nil
f.closed? # => false
f.close_read # =>...

• IO

Rake.application=(app) (18445.0)

• 2.7.0

• 特異メソッド

現在の Rake アプリケーションをセットします。

現在の Rake アプリケーションをセットします。

@param app Rake::Application のインスタンスを指定します。

//emlist[][ruby]{
# Rakefile での記載例とする

require 'pp'

task default: :test_rake_app
task :test_rake_app do
app = Rake::Application.new
app.tty_output = true
Rake.application = app
pp Rake.application
end

# => #<Rake::App...

• Rake
• Rake::Application

絞り込み条件を変える

String#lines(rs = $/, chomp: false) -> [String] (18445.0)

• 2.7.0

• インスタンスメソッド

文字列中の各行を文字列の配列で返します。(self.each_line.to_a と同じです)

文字列中の各行を文字列の配列で返します。(self.each_line.to_a と同じです)

//emlist[][ruby]{
"aa\nbb\ncc\n".lines # => ["aa\n", "bb\n", "cc\n"]
//}

行の区切りは rs に指定した文字列で、 そのデフォルト値は変数 $/ の値です。
各 line には区切りの文字列も含みます。

rs に nil を指定すると行区切りなしとみなします。 rs に空文字列 "" を指
定すると「パラグラフモード」になり、 改行コードが 2 つ以上連続するとこ
ろで文字列を分割します (つまり空行で分割します)。

...

• String

WIN32OLE_TYPE#default_event_sources -> [WIN32OLE_TYPE] (18445.0)

• 2.7.0

• インスタンスメソッド

型が持つソースインターフェイスを取得します。

型が持つソースインターフェイスを取得します。

default_event_sourcesメソッドは、selfがCoClass（コンポーネントクラス）
の場合、そのクラスがサポートするデフォルトのソースインターフェイス（イ
ベントの通知元となるインターフェイス）を返します。

@return デフォルトのソースインターフェイスをWIN32OLE_TYPEの配列と
して返します。返すのは配列ですが、デフォルトのソースインターフェ
イスは最大でも1インターフェイスです。ソースインターフェイスを持
たない場合は空配列を返します。

tobj = ...

• WIN32OLE_TYPE

IO#readlines(rs = $/, chomp: false) -> [String] (18427.0)

• 2.7.0

• インスタンスメソッド

データを全て読み込んで、その各行を要素としてもつ配列を返します。 既に EOF に達していれば空配列 [] を返します。

データを全て読み込んで、その各行を要素としてもつ配列を返します。
既に EOF に達していれば空配列 [] を返します。

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

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

@param rs 行の区切りを文字列で指定します。rs に nil を指定すると行区切りなしとみなします。
空文字列 "" を指定すると連続する改行を行の区切りとみなします(パラグラフモード)。
@param limit 最大の読み込みバイト数
@param chomp tru...

• IO

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

• 2.7.0

• 特異メソッド

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

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

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

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

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

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

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

• IO

NilClass#&(other) -> false (18427.0)

• 2.7.0

• インスタンスメソッド

常に false を返します。

常に false を返します。

@param other 論理積を行なう式です

//emlist[例][ruby]{
nil & true # => false
nil & false # => false
nil & nil # => false
nil & "a" # => false
//}

• NilClass

絞り込み条件を変える

Ruby プログラムの実行 (18418.0)

• 2.7.0

• 文書

Ruby プログラムの実行 === Ruby プログラム

Ruby プログラムの実行
=== Ruby プログラム

Ruby プログラムの実行は文の連なりの評価です。なんらかの形であたえられたプログラムテキストをコンパイルし、BEGIN 文があればそれを評価し、トップレベルの式の連なりを評価し、END ブロックがあれば最後にそれを評価して終了します (終了処理の詳細については spec/terminate を参照のこと)。

=== 文

==== if

if 文は、まず条件式を評価し、その値が真ならば対応する本体を評価します。
偽ならば elsif 節の条件式を順番に評価し、その値が始めて真になった節の
本体を評価します。それらがすべて偽なら...

• Binding
• LocalJumpError
• NameError
• Object
• Proc
• Symbol
• spec/terminate

WEBrick::Config::SSL -> Hash (18409.0)

• 2.7.0

• 定数

以下のほとんどの項目はサーバが保持する OpenSSL::SSL::SSLContext オブジェクト を設定するためのものです。詳しくは OpenSSL::SSL::SSLContext を参照して下さい。

以下のほとんどの項目はサーバが保持する OpenSSL::SSL::SSLContext オブジェクト
を設定するためのものです。詳しくは OpenSSL::SSL::SSLContext を参照して下さい。

: :ServerSoftware
サーバソフト名を設定する。デフォルトでは
"WEBrick/VERSION (Ruby/VERSION/RELEASE_DATE) OpenSSL/VERSION"。
: :SSLEnable
ssl を有効にするかどうかを設定します。
Ruby 1.8.2 まではデフォルトで true です。
Ruby 1.8.3 以降はデフ...

• OpenSSL::PKey::PKey
• OpenSSL::SSL::SSLContext
• OpenSSL::X509::Certificate
• WEBrick::Config

Thread::Queue#closed? -> bool (18403.0)

• 2.7.0

• インスタンスメソッド

キューが close されている時に true を返します。

キューが close されている時に true を返します。

//emlist[例][ruby]{
q = Queue.new

[:resource1, :resource2, :resource3, nil].each { |r| q.push(r) }

q.closed? # => false
q.close
q.closed? # => true
//}

• Thread::Queue

Hash#filter! -> Enumerator (18397.0)

• 2.7.0

• インスタンスメソッド

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

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

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

ブロックが与えられなかった場合は、自身と keep_if から生成した
Enumerator オブジェクトを返します。

//emlist[例][ruby]{
h1 = {}
c = ("a".."g")
c.each_with_index {|e, i| h1[i] = e }

h2 = h1.dup
h1.select!...

• Enumerator
• Hash

Hash#select! -> Enumerator (18397.0)

• 2.7.0

• インスタンスメソッド

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

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

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

ブロックが与えられなかった場合は、自身と keep_if から生成した
Enumerator オブジェクトを返します。

//emlist[例][ruby]{
h1 = {}
c = ("a".."g")
c.each_with_index {|e, i| h1[i] = e }

h2 = h1.dup
h1.select!...

• Enumerator
• Hash

絞り込み条件を変える

CSV#unconverted_fields? -> bool (18391.0)

• 2.7.0

• インスタンスメソッド

パースした結果が unconverted_fields というメソッドを持つ場合に真を返します。 そうでない場合は、偽を返します。

パースした結果が unconverted_fields というメソッドを持つ場合に真を返します。
そうでない場合は、偽を返します。


//emlist[例][ruby]{
require "csv"

csv = CSV.new("date1,date2\n2018-07-09,2018-07-10")
csv.unconverted_fields? # => nil
csv = CSV.new("date1,date2\n2018-07-09,2018-07-10", unconverted_fields: false)
csv.unconverted_fields? # => fals...

• CSV

Pathname#cleanpath(consider_symlink = false) -> Pathname (18391.0)

• 2.7.0

• インスタンスメソッド

余計な "."、".." や "/" を取り除いた新しい Pathname オブジェクトを返します。

余計な "."、".." や "/" を取り除いた新しい Pathname オブジェクトを返します。

cleanpath は、実際にファイルシステムを参照することなく、文字列操作
だけで処理を行います。

@param consider_symlink 真ならパス要素にシンボリックリンクがあった場合
にも問題ないように .. を残します。

//emlist[例][ruby]{
require "pathname"
path = Pathname.new("//.././../")
path # => #<Pa...

• Pathname

Object#singleton_class -> Class (18373.0)

• 2.7.0

• インスタンスメソッド

レシーバの特異クラスを返します。 まだ特異クラスがなければ、新しく作成します。

レシーバの特異クラスを返します。
まだ特異クラスがなければ、新しく作成します。

レシーバが nil か true か false なら、それぞれ NilClass, TrueClass,
FalseClass を返します。

@raise TypeError レシーバが Integer、Float、Symbol の場合に発生します。

//emlist[][ruby]{
Object.new.singleton_class #=> #<Class:#<Object:0xb7ce1e24>>
String.singleton_class #=> #<Class:String>
n...

• Float
• Integer
• Object
• Symbol

CSV::FieldInfo#line -> Integer (18355.0)

• 2.7.0

• インスタンスメソッド

行番号を返します。

行番号を返します。

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

csv = CSV.new("date1,date2,date3\n2018-07-09,2018-07-10\n2018-08-09,2018-08-10", headers: true)
csv.convert do |field,field_info|
p field_info.line
Date.parse(field)
end
p csv.to_a

# => 2
# => 2
# => 3
# => 3
# => [#<CSV::Row "date1":#<Date: 2018-07...

• CSV::FieldInfo

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

• 2.7.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 (18355.0)

• 2.7.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

IO#fcntl(cmd, arg = 0) -> Integer (18355.0)

• 2.7.0

• インスタンスメソッド

IOに対してシステムコール fcntl を実行します。 機能の詳細は fcntl(2) を参照してください。 fcntl(2) が返した整数を返します。

IOに対してシステムコール fcntl を実行します。
機能の詳細は fcntl(2) を参照してください。
fcntl(2) が返した整数を返します。

@param cmd IO に対するコマンドを、添付ライブラリ fcntl が提供している定数で指定します。

@param arg cmd に対する引数を整数、文字列、booleanのいずれかで指定します。
整数の時にはその値を fcntl(2) に渡します。
文字列の場合には Array#pack した構造体だとみなして渡します。
arg が nil か false の...

• IO
• fcntl

String#each_line(rs = $/, chomp: false) -> Enumerator (18355.0)

• 2.7.0

• インスタンスメソッド

文字列中の各行に対して繰り返します。 行の区切りは rs に指定した文字列で、 そのデフォルト値は変数 $/ の値です。 各 line には区切りの文字列も含みます。

文字列中の各行に対して繰り返します。
行の区切りは rs に指定した文字列で、
そのデフォルト値は変数 $/ の値です。
各 line には区切りの文字列も含みます。

rs に nil を指定すると行区切りなしとみなします。
rs に空文字列 "" を指定すると「パラグラフモード」になり、
改行コードが 2 つ以上連続するところで文字列を分割します
(つまり空行で分割します)。

@param rs 行末を示す文字列
@param chomp true を指定すると各行の末尾から rs を取り除きます。

//emlist[例][ruby]{
"aa\nbb\ncc\n".each_...

• String

Thread::SizedQueue#close -> self (18355.0)

• 2.7.0

• インスタンスメソッド

キューを close します。詳しくは Thread::Queue#close を参照してください。

キューを close します。詳しくは Thread::Queue#close を参照してください。

Thread::Queue とはキューにオブジェクトを追加するスレッドの動作が
異なります。キューにオブジェクトを追加するスレッドを待機している場合は
ClosedQueueError が発生して中断されます。

//emlist[例][ruby]{
q = SizedQueue.new(4)

[:resource1, :resource2, :resource3, nil].each { |r| q.push(r) }

q.closed? # => false
q.close
q.c...

• ClosedQueueError
• Thread::Queue
• Thread::SizedQueue

Time.local(sec, min, hour, mday, mon, year, wday, yday, isdst, zone) -> Time (18343.0)

• 2.7.0

• 特異メソッド

引数で指定した地方時の Time オブジェクトを返します。

引数で指定した地方時の Time オブジェクトを返します。

引数の順序は Time#to_a と全く同じです。
引数 wday, yday, zone に指定した値は無視されます。
引数に nil を指定した場合の値はその引数がとり得る最小の値です。

@param sec 秒を 0 から 60 までの整数か文字列で指定します。(60はうるう秒)

@param min 分を 0 から 59 までの整数か文字列で指定します。

@param hour 時を 0 から 23 までの整数か文字列で指定します。

@param mday 日を 1 から 31 までの整数か文字列で指定しま...

• Time

絞り込み条件を変える

Time.local(year, mon = 1, day = 1, hour = 0, min = 0, sec = 0, usec = 0) -> Time (18343.0)

• 2.7.0

• 特異メソッド

引数で指定した地方時の Time オブジェクトを返します。

引数で指定した地方時の Time オブジェクトを返します。

第2引数以降に nil を指定した場合の値はその引数がとり得る最小の値です。

@param year 年を整数か文字列で指定します。例えば 1998 年に対して 1998 を指定します。

@param mon 1(1月)から 12(12月)の範囲の整数または文字列で指定します。
英語の月名("Jan", "Feb", ... などの省略名。文字の大小は無視)も指定できます。

@param day 日を 1 から 31 までの整数か文字列で指定します。

@param hour 時を 0 から 23 ...

• Time

REXML::XMLDecl (18127.0)

• 2.7.0

• クラス

XML 宣言を表すクラス。

XML 宣言を表すクラス。

文書から XML 宣言を取り出すには REXML::Document#xml_decl を使います。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<e />
EOS

xml_decl = doc.xml_decl
xml_decl.version # => "1.0"
xml_decl.encoding # => "UTF-8"
xml_de...

rexml/parsers/streamparser (18127.0)

• 2.7.0

• ライブラリ

ストリーム式の XML パーサ。

ストリーム式の XML パーサ。

rexml の XML パーサの中では高速ですが、機能は限定的です。
もう少し高機能なストリーム式パーサが必要な場合は
REXML::Parsers::SAX2Parser を用いてください。

パーサからはコールバックによってパースした情報を受け取ります。
REXML::StreamListener を include し、
必要なメソッドをオーバーライドしたクラスのオブジェクトを
コールバックオブジェクトとして REXML::Parsers::StreamParser.new
に渡します。

REXML::Parsers::StreamParser#pa...

• REXML::Parsers::StreamParser

ruby 1.8.2 feature (11356.0)

• 2.7.0

• 文書

ruby 1.8.2 feature ruby 1.8.2 での ruby 1.8.1 からの変更点です。

ruby 1.8.2 feature
ruby 1.8.2 での ruby 1.8.1 からの変更点です。

掲載方針

*バグ修正の影響も含めて動作が変わるものを収録する。
*単にバグを直しただけのものは収録しない。
*ライブラリへの単なる定数の追加は収録しない。

以下は各変更点に付けるべきタグです。

*カテゴリ
* [ruby]: ruby インタプリタの変更
* [api]: 拡張ライブラリ API
* [lib]: ライブラリ
*レベル
* [bug]: バグ修正
* [new]: 追加されたクラス／メソッドなど
* [compat]: 変更されたクラス／...

REXML::Text.new(arg, respect_whitespace = false, parent = nil, raw = nil, entity_filter = nil, illegal = REXML::Text::NEEDS_A_SECOND_CHECK) (10462.0)

• 2.7.0

• 特異メソッド

テキストノードオブジェクトを生成します。

テキストノードオブジェクトを生成します。

arg でノードの内容を指定します。
文字列の場合はそれが内容として使われます。
REXML::Text オブジェクトの場合はその内容が複製されます。

respect_whitespace に真を指定すると、arg に含まれる空白文字は保存されます。
偽の場合は空白はまとめられます。

raw は true, false, nil のいずれかを指定し、生成されるテキストノードが
raw モードであるかどうかを決めます。
true の場合、そのノードは raw モードであると解釈され、
テキストにはエスケープされていないXMLマークアップは
含まれ...

• REXML::DocType
• REXML::Document
• REXML::Text

絞り込み条件を変える

Logger#add(severity, message = nil, progname = nil) -> true (10291.0)

• 2.7.0

• インスタンスメソッド

メッセージをログに記録します。

メッセージをログに記録します。

ブロックを与えた場合はブロックを評価した返り値をメッセージとしてログに記録します。
ユーザがこのメソッドを直接使うことはあまりありません。

@param severity ログレベル。Logger クラスで定義されている定数を指定します。
この値がレシーバーに設定されているレベルよりも低い場合、
メッセージは記録されません。

@param message ログに出力するメッセージを文字列か例外オブジェクトを指定します。
省略すると nil が用いられます。

@...

• Logger

Logger#add(severity, message = nil, progname = nil) { ... } -> true (10291.0)

• 2.7.0

• インスタンスメソッド

メッセージをログに記録します。

メッセージをログに記録します。

ブロックを与えた場合はブロックを評価した返り値をメッセージとしてログに記録します。
ユーザがこのメソッドを直接使うことはあまりありません。

@param severity ログレベル。Logger クラスで定義されている定数を指定します。
この値がレシーバーに設定されているレベルよりも低い場合、
メッセージは記録されません。

@param message ログに出力するメッセージを文字列か例外オブジェクトを指定します。
省略すると nil が用いられます。

@...

• Logger

Kernel.#system(command, options={}) -> bool | nil (10264.0)

• 2.7.0

• モジュール関数

引数を外部コマンドとして実行して、成功した時に真を返します。

引数を外部コマンドとして実行して、成功した時に真を返します。

子プロセスが終了ステータス 0 で終了すると成功とみなし true を返します。
それ以外の終了ステータスの場合は false を返します。
コマンドを実行できなかった場合は nil を返します。

options で :exception に true を指定することで、
nil や false を返す代わりに例外を発生するようにできます。

終了ステータスは変数 $? で参照できます。

コマンドを実行することができなかった場合、多くのシェルはステータス
127 を返します。シェルを介さない場合は Ruby の子プロセスがス...

• Kernel

Kernel.#system(env, command, options={}) -> bool | nil (10264.0)

• 2.7.0

• モジュール関数

引数を外部コマンドとして実行して、成功した時に真を返します。

引数を外部コマンドとして実行して、成功した時に真を返します。

子プロセスが終了ステータス 0 で終了すると成功とみなし true を返します。
それ以外の終了ステータスの場合は false を返します。
コマンドを実行できなかった場合は nil を返します。

options で :exception に true を指定することで、
nil や false を返す代わりに例外を発生するようにできます。

終了ステータスは変数 $? で参照できます。

コマンドを実行することができなかった場合、多くのシェルはステータス
127 を返します。シェルを介さない場合は Ruby の子プロセスがス...

• Kernel

制御構造 (10225.0)

• 2.7.0

• 文書

制御構造 条件分岐: * if * unless * case 繰り返し: * while * until * for * break * next * redo * retry 例外処理: * raise * begin その他: * return * BEGIN * END

制御構造
条件分岐:
* if
* unless
* case
繰り返し:
* while
* until
* for
* break
* next
* redo
* retry
例外処理:
* raise
* begin
その他:
* return
* BEGIN
* END

Rubyでは(Cなどとは異なり)制御構造は式であって、何らかの値を返すものが
あります(返さないものもあります。値を返さない式を代入式の右辺に置くと
syntax error になります)。

R...

• Interrupt
• Kernel
• RuntimeError
• StandardError
• SyntaxError
• SystemExit
• TypeError
• _builtin
• spec/terminate

絞り込み条件を変える

Kernel.#system(env, program, *args, options={}) -> bool | nil (10129.0)

• 2.7.0

• モジュール関数

引数を外部コマンドとして実行して、成功した時に真を返します。

引数を外部コマンドとして実行して、成功した時に真を返します。

子プロセスが終了ステータス 0 で終了すると成功とみなし true を返します。
それ以外の終了ステータスの場合は false を返します。
コマンドを実行できなかった場合は nil を返します。

options で :exception に true を指定することで、
nil や false を返す代わりに例外を発生するようにできます。

終了ステータスは変数 $? で参照できます。

コマンドを実行することができなかった場合、多くのシェルはステータス
127 を返します。シェルを介さない場合は Ruby の子プロセスがス...

• Kernel

Kernel.#system(program, *args, options={}) -> bool | nil (10129.0)

• 2.7.0

• モジュール関数

引数を外部コマンドとして実行して、成功した時に真を返します。

引数を外部コマンドとして実行して、成功した時に真を返します。

子プロセスが終了ステータス 0 で終了すると成功とみなし true を返します。
それ以外の終了ステータスの場合は false を返します。
コマンドを実行できなかった場合は nil を返します。

options で :exception に true を指定することで、
nil や false を返す代わりに例外を発生するようにできます。

終了ステータスは変数 $? で参照できます。

コマンドを実行することができなかった場合、多くのシェルはステータス
127 を返します。シェルを介さない場合は Ruby の子プロセスがス...

• Kernel

Symbol#casecmp?(other) -> bool | nil (10096.0)

• 2.7.0

• インスタンスメソッド

大文字小文字の違いを無視しシンボルを比較します。 シンボルが一致する場合には true を返し、一致しない場合には false を返します。

大文字小文字の違いを無視しシンボルを比較します。
シンボルが一致する場合には true を返し、一致しない場合には false を返します。

@param other 比較対象のシンボルを指定します。

//emlist[][ruby]{
:abcdef.casecmp?(:abcde) #=> false
:aBcDeF.casecmp?(:abcdef) #=> true
:abcdef.casecmp?(:abcdefg) #=> false
:abcdef.casecmp?(:ABCDEF) #=> true
:"\u{e4 f6 fc}".casecmp?...

• Symbol

Kernel$$-v -> bool | nil (10084.0)

• 2.7.0

• 変数

冗長メッセージフラグです。Rubyインタプリタへの コマンドラインオプション -v でセットされます。

冗長メッセージフラグです。Rubyインタプリタへの
コマンドラインオプション -v でセットされます。

警告レベルは三段階あり、それぞれ以下の通りです。

: nil
警告を出力しない
: false
重要な警告のみ出力 (デフォルト)
: true
すべての警告を出力する

$VERBOSE に nil, false 以外を代入すると値は true になります。

$VERBOSE の値はコマンドラインオプション
-W でも設定できます。
-W0 オプションで nil、
-W1 オプションで false、
-W2, -W オプションで true が設定されます。
-...

• Kernel
• spec/rubycmd

Kernel$$-w -> bool | nil (10084.0)

• 2.7.0

• 変数

冗長メッセージフラグです。Rubyインタプリタへの コマンドラインオプション -v でセットされます。

冗長メッセージフラグです。Rubyインタプリタへの
コマンドラインオプション -v でセットされます。

警告レベルは三段階あり、それぞれ以下の通りです。

: nil
警告を出力しない
: false
重要な警告のみ出力 (デフォルト)
: true
すべての警告を出力する

$VERBOSE に nil, false 以外を代入すると値は true になります。

$VERBOSE の値はコマンドラインオプション
-W でも設定できます。
-W0 オプションで nil、
-W1 オプションで false、
-W2, -W オプションで true が設定されます。
-...

• Kernel
• spec/rubycmd

絞り込み条件を変える

Kernel$$VERBOSE -> bool | nil (10084.0)

• 2.7.0

• 変数

冗長メッセージフラグです。Rubyインタプリタへの コマンドラインオプション -v でセットされます。

冗長メッセージフラグです。Rubyインタプリタへの
コマンドラインオプション -v でセットされます。

警告レベルは三段階あり、それぞれ以下の通りです。

: nil
警告を出力しない
: false
重要な警告のみ出力 (デフォルト)
: true
すべての警告を出力する

$VERBOSE に nil, false 以外を代入すると値は true になります。

$VERBOSE の値はコマンドラインオプション
-W でも設定できます。
-W0 オプションで nil、
-W1 オプションで false、
-W2, -W オプションで true が設定されます。
-...

• Kernel
• spec/rubycmd

Module#<(other) -> bool | nil (10078.0)

• 2.7.0

• インスタンスメソッド

比較演算子。self が other の子孫である場合、 true を返します。 self が other の先祖か同一のクラス／モジュールである場合、false を返します。

比較演算子。self が other の子孫である場合、 true を返します。
self が other の先祖か同一のクラス／モジュールである場合、false を返します。

継承関係にないクラス同士の比較では
nil を返します。

@param other 比較対象のモジュールやクラス

@raise TypeError other がクラスやモジュールではない場合に発生します。

//emlist[例][ruby]{
module Foo
end
class Bar
include Foo
end
class Baz < Bar
end
class Qux
end
p Bar ...

• Module

OpenSSL::BN#prime_fasttest?(checks=nil, vtrivdiv=true) -> bool (10063.0)

• 2.7.0

• インスタンスメソッド

自身が素数であるなら true を返します。

自身が素数であるなら true を返します。

vtrivdiv が真である場合には、 Miller-Rabin 法での
判定の前に小さな素数で割ることで素数か否かを
調べます。自身が小さな素数である場合にはこの手順
により素数ではないと誤った返り値を返します。

Miller-Rabin 法により確率的に判定します。
checksで指定した回数だけ繰り返します。
checksがnilである場合は OpenSSL が適切な
回数を判断します。

//emlist[][ruby]{
require 'openssl'

# 181 は 「小さな素数」である
OpenSSL::BN.new("18...

• OpenSSL::BN

Module#<=(other) -> bool | nil (10060.0)

• 2.7.0

• インスタンスメソッド

比較演算子。self が other の子孫であるか、self と other が 同一クラスである場合、 true を返します。 self が other の先祖である場合、false を返します。

比較演算子。self が other の子孫であるか、self と other が
同一クラスである場合、 true を返します。
self が other の先祖である場合、false を返します。

継承関係にないクラス同士の比較では
nil を返します。

@param other 比較対象のモジュールやクラス

@raise TypeError other がクラスやモジュールではない場合に発生します。

@see Module#<

//emlist[例][ruby]{
module Foo; end
module Bar
include Foo
end
module Baz
...

• Module

Module#>=(other) -> bool | nil (10060.0)

• 2.7.0

• インスタンスメソッド

比較演算子。self が other の先祖か同一クラスである場合、 true を返します。 self が other の子孫である場合、false を返します。

比較演算子。self が other の先祖か同一クラスである場合、 true を返します。
self が other の子孫である場合、false を返します。

継承関係にないクラス同士の比較では
nil を返します。

@param other 比較対象のモジュールやクラス

@raise TypeError other がクラスやモジュールではない場合に発生します。

@see Module#<

//emlist[例][ruby]{
module Foo; end
module Bar
include Foo
end
module Baz
prepend Foo
end

...

• Module

絞り込み条件を変える