検索結果

RbConfig.ruby -> String (72655.0)

• 3.2

• 特異メソッド

ruby コマンドのフルパスを返します。

ruby コマンドのフルパスを返します。

• RbConfig

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

• 3.2

• 特異メソッド

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

Gem.ruby_engine -> String (36655.0)

• 3.2

• 特異メソッド

Ruby処理系実装の種類を表す文字列を返します。

Ruby処理系実装の種類を表す文字列を返します。

• Gem

Gem::QuickLoader.load_full_rubygems_library (36604.0)

• 3.2

• 特異メソッド

prelude.c で定義されている内部用のメソッドです。

prelude.c で定義されている内部用のメソッドです。

• Gem::QuickLoader

Symbol.all_symbols -> [Symbol] (27640.0)

• 3.2

• 特異メソッド

定義済みの全てのシンボルオブジェクトの配列を返します。

定義済みの全てのシンボルオブジェクトの配列を返します。

p Symbol.all_symbols #=> [:RUBY_PLATFORM, :RUBY_VERSION, ...]

リテラルで表記したシンボルのうち、コンパイル時に値が決まるものはその時に生成されます。
それ以外の式展開を含むリテラルや、メソッドで表記されたものは式の評価時に生成されます。
(何にも使われないシンボルは最適化により生成されないことがあります)

def number
'make_3'
end

p Symbol.all_symbols.select{|sym|sym.to_s.in...

• Symbol

絞り込み条件を変える

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

• 3.2

• 特異メソッド

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 (27322.0)

• 3.2

• 特異メソッド

バイナリフォーマットの文字列から埋め込まれた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

WIN32OLE_TYPE.typelibs -> [String] (27322.0)

• 3.2

• 特異メソッド

システムに登録されているすべてのTypeLibのドキュメント文字列を取得します。

システムに登録されているすべてのTypeLibのドキュメント文字列を取得します。

@return システムに登録されているすべてのTypeLibのドキュメント文字列の配
列を返します。

Ruby-1.9.1からは、すべてのTypeLibのドキュメント文字列を取得するには、
WIN32OLE_TYPELIBオブジェクトを利用して、以下のように記述してくだ
さい。

WIN32OLE_TYPELIB.typelibs.map {|t| t.name}

• WIN32OLE_TYPE
• WIN32OLE_TYPELIB

RubyVM::AbstractSyntaxTree.parse(string) -> RubyVM::AbstractSyntaxTree::Node (18712.0)

• 3.2

• 特異メソッド

文字列を抽象構文木にパースし、その木の根ノードを返します。

文字列を抽象構文木にパースし、その木の根ノードを返します。

@param string パースする対象の Ruby のコードを文字列で指定します。
@param keep_script_lines true を指定すると、 Node#script_lines でノードと関連づけられたソースコードのテキストを取得できます。
@param keep_tokens true を指定すると、 Node#token が利用できます。
@param error_tolerant true を指定すると、構文エラーが発生した際にエラー箇所を type が :ERROR であるようなノードに置き換えてツリ...

• RubyVM::AbstractSyntaxTree

RubyVM::AbstractSyntaxTree.parse(string, keep_script_lines: false, error_tolerant: false, keep_tokens: false) -> RubyVM::AbstractSyntaxTree::Node (18712.0)

• 3.2

• 特異メソッド

文字列を抽象構文木にパースし、その木の根ノードを返します。

文字列を抽象構文木にパースし、その木の根ノードを返します。

@param string パースする対象の Ruby のコードを文字列で指定します。
@param keep_script_lines true を指定すると、 Node#script_lines でノードと関連づけられたソースコードのテキストを取得できます。
@param keep_tokens true を指定すると、 Node#token が利用できます。
@param error_tolerant true を指定すると、構文エラーが発生した際にエラー箇所を type が :ERROR であるようなノードに置き換えてツリ...

• RubyVM::AbstractSyntaxTree

絞り込み条件を変える

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

• 3.2

• 特異メソッド

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

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

• 3.2

• 特異メソッド

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

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

• 3.2

• 特異メソッド

引数 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::AbstractSyntaxTree.parse_file(pathname) -> RubyVM::AbstractSyntaxTree::Node (18640.0)

• 3.2

• 特異メソッド

pathname のファイルを読み込み、その内容を抽象構文木にパースし、その木の根ノードを返します。

pathname のファイルを読み込み、その内容を抽象構文木にパースし、その木の根ノードを返します。

@param pathname パースする対象のファイルパスを指定します
@param keep_script_lines true を指定すると、 Node#script_lines でノードと関連づけられたソースコードのテキストを取得できます。
@param keep_tokens true を指定すると、 Node#token が利用できます。
@param error_tolerant true を指定すると、構文エラーが発生した際にエラー箇所を type が :ERROR である...

• RubyVM::AbstractSyntaxTree

RubyVM::AbstractSyntaxTree.parse_file(pathname, keep_script_lines: false, error_tolerant: false, keep_tokens: false) -> RubyVM::AbstractSyntaxTree::Node (18640.0)

• 3.2

• 特異メソッド

pathname のファイルを読み込み、その内容を抽象構文木にパースし、その木の根ノードを返します。

pathname のファイルを読み込み、その内容を抽象構文木にパースし、その木の根ノードを返します。

@param pathname パースする対象のファイルパスを指定します
@param keep_script_lines true を指定すると、 Node#script_lines でノードと関連づけられたソースコードのテキストを取得できます。
@param keep_tokens true を指定すると、 Node#token が利用できます。
@param error_tolerant true を指定すると、構文エラーが発生した際にエラー箇所を type が :ERROR である...

• RubyVM::AbstractSyntaxTree

絞り込み条件を変える

IO.copy_stream(src, dst, copy_length = nil) -> Integer (18622.0)

• 3.2

• 特異メソッド

指定された src から dst へコピーします。 コピーしたバイト数を返します。

指定された src から dst へコピーします。
コピーしたバイト数を返します。

コピー元の src が IO オブジェクトの場合は、src のオフセットから
ファイル名の場合はファイルの最初からコピーを開始します。
コピー先の dst に関しても同様です。

dst にファイル名を指定し、そのファイルが存在しない場合、
ファイルは作成されます。ファイルが存在する場合は長さ 0 に切り詰められます。

src が IO オブジェクトでかつ src_offset が指定されている場合、
src のオフセット(src.pos)は変更されません。

@param src コピー元となる IO ...

• IO

IO.copy_stream(src, dst, copy_length, src_offset) -> Integer (18622.0)

• 3.2

• 特異メソッド

指定された src から dst へコピーします。 コピーしたバイト数を返します。

指定された src から dst へコピーします。
コピーしたバイト数を返します。

コピー元の src が IO オブジェクトの場合は、src のオフセットから
ファイル名の場合はファイルの最初からコピーを開始します。
コピー先の dst に関しても同様です。

dst にファイル名を指定し、そのファイルが存在しない場合、
ファイルは作成されます。ファイルが存在する場合は長さ 0 に切り詰められます。

src が IO オブジェクトでかつ src_offset が指定されている場合、
src のオフセット(src.pos)は変更されません。

@param src コピー元となる IO ...

• IO

RubyVM::AbstractSyntaxTree.of(proc) -> RubyVM::AbstractSyntaxTree::Node (18622.0)

• 3.2

• 特異メソッド

引数 proc に渡したProcやメソッドオブジェクトの抽象構文木を返します。

引数 proc に渡したProcやメソッドオブジェクトの抽象構文木を返します。

このメソッドはProcやメソッドが定義されたファイルを読み込む必要があるため、
irbのようなファイルを介さない対話的環境では動作しません。

@param proc Procもしくはメソッドオブジェクトを指定します。
@param keep_script_lines true を指定すると、 Node#script_lines でノードと関連づけられたソースコードのテキストを取得できます。
@param keep_tokens true を指定すると、 Node#token が利用できます。
@param e...

• RubyVM::AbstractSyntaxTree

RubyVM::AbstractSyntaxTree.of(proc, keep_script_lines: false, error_tolerant: false, keep_tokens: false) -> RubyVM::AbstractSyntaxTree::Node (18622.0)

• 3.2

• 特異メソッド

引数 proc に渡したProcやメソッドオブジェクトの抽象構文木を返します。

引数 proc に渡したProcやメソッドオブジェクトの抽象構文木を返します。

このメソッドはProcやメソッドが定義されたファイルを読み込む必要があるため、
irbのようなファイルを介さない対話的環境では動作しません。

@param proc Procもしくはメソッドオブジェクトを指定します。
@param keep_script_lines true を指定すると、 Node#script_lines でノードと関連づけられたソースコードのテキストを取得できます。
@param keep_tokens true を指定すると、 Node#token が利用できます。
@param e...

• RubyVM::AbstractSyntaxTree

RDoc::Parser::Ruby.new(top_level, file_name, body, options, stats) -> RDoc::Parser::Ruby (18607.0)

• 3.2

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param top_level RDoc::TopLevel オブジェクトを指定します。

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

@param body ソースコードの内容を文字列で指定します。

@param options RDoc::Options オブジェクトを指定します。

@param stats RDoc::Stats オブジェクトを指定します。

• RDoc::Options
• RDoc::Parser::Ruby
• RDoc::Stats
• RDoc::TopLevel

絞り込み条件を変える

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

• 3.2

• 特異メソッド

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

Object.yaml_tag(tag) -> () (18358.0)

• 3.2

• 特異メソッド

クラスと tag の間を関連付けます。

クラスと tag の間を関連付けます。

これによって tag 付けされた YAML ドキュメントを Ruby のオブジェクトに
変換したりその逆をしたりすることができます。

@param tag 対象のクラスに関連付けるタグの文字列

=== Example
require 'psych'

class Foo
def initialize(x)
@x = x
end

attr_reader :x
end

# Dumps Ruby object normally
p Psych.dump(Foo.new(3))
...

• Object

Net::HTTP.Proxy(address, port = 80) -> Class (18340.0)

• 3.2

• 特異メソッド

Proxy 経由で http サーバに接続するためのクラスを作成し返します。

Proxy 経由で http サーバに接続するためのクラスを作成し返します。

このクラスは Net::HTTP を継承しているので Net::HTTP と全く
同じように使えます。指定されたプロクシを常に経由して http サーバ
に接続します。

address が nil のときは Net::HTTP クラスをそのまま返します。

//emlist[例1: Net::HTTP.new を使う][ruby]{
require 'net/http'
proxy_class = Net::HTTP::Proxy('proxy.example.com', 8080)
http = proxy_...

• Net::HTTP

REXML::Document.entity_expansion_text_limit -> Integer (18340.0)

• 3.2

• 特異メソッド

実体参照の展開による文字列の増分(テキストのバイト数)の 最大値を指定します。

実体参照の展開による文字列の増分(テキストのバイト数)の
最大値を指定します。

展開によって増分値がこの値を越えると
例外を発生させ、処理を中断します。

実体参照の展開処理を使った DoS 攻撃に対抗するための
仕組みです。

デフォルトは 10240 (byte) です。

このメソッドは Ruby 2.1 から deprecated になりました。
REXML::Security.entity_expansion_text_limit を使ってください。

@see REXML::Document.entity_expansion_text_limit=,
http://ww...

• REXML::Document

REXML::Document.entity_expansion_text_limit=(val) (18340.0)

• 3.2

• 特異メソッド

実体参照の展開による文字列の増分(テキストのバイト数)の 最大値を指定します。

実体参照の展開による文字列の増分(テキストのバイト数)の
最大値を指定します。

展開によって増分値がこの値を越えると
例外を発生させ、処理を中断します。

実体参照の展開処理を使った DoS 攻撃に対抗するための
仕組みです。

デフォルトは 10240 (byte) です。

このメソッドは Ruby 2.1 から deprecated になりました。
REXML::Security.entity_expansion_text_limit= を使ってください。

@see REXML::Document.entity_expansion_text_limit
http://www...

• REXML::Document

絞り込み条件を変える

Socket.gethostbyname(host) -> Array (18340.0)

• 3.2

• 特異メソッド

ホスト名または IP アドレス(指定方法に関しては lib:socket#host_formatを参照) からホストの情報を返します。

ホスト名または IP アドレス(指定方法に関しては
lib:socket#host_formatを参照)
からホストの情報を返します。

@param host 文字列でホストを指定します。

@return ホスト情報を含んだ４要素の配列を返します。

=== 返り値のホスト情報について
ホスト情報は以下の 4 要素の配列で表現されています。

* ホスト名
* ホストの別名の配列
* ホストのアドレスタイプ (整数定数)
* ホストのアドレス

第四要素のホストのアドレスは、各アドレスタイプに対応する
C のアドレス構造体を pack した文字列として表現されています。
...

• Socket

TCPSocket.gethostbyname(host) -> Array (18340.0)

• 3.2

• 特異メソッド

ホスト名または IP アドレス (整数または"127.0.0.1" のような文字列)からホストの情報を返します。ホスト情報は、ホ スト名、ホストの別名の配列、ホストのアドレスタイプ、ホストの アドレスを各要素とする配列です。ホストのアドレスは octet decimal の文字列 ("127.0.0.1"のような文字列) や IPv6 アドレス ("::1" のような文字列) です。

ホスト名または IP アドレス (整数または"127.0.0.1"
のような文字列)からホストの情報を返します。ホスト情報は、ホ
スト名、ホストの別名の配列、ホストのアドレスタイプ、ホストの
アドレスを各要素とする配列です。ホストのアドレスは octet
decimal の文字列 ("127.0.0.1"のような文字列) や IPv6
アドレス ("::1" のような文字列) です。

@param host ホスト名または IP アドレス (整数または"127.0.0.1" のような文字列)を指定します。

@return ホスト名、ホストの別名の配列、ホストのアドレスタイプ、ホストのアド...

• TCPSocket

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

• 3.2

• 特異メソッド

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

Date.today(start = Date::ITALY) -> Date (18322.0)

• 3.2

• 特異メソッド

現在の日付に相当する日付オブジェクトを生成します。

現在の日付に相当する日付オブジェクトを生成します。

@param start グレゴリオ暦をつかい始めた日をあらわすユリウス日

//emlist[例][ruby]{
require 'date'
Date.today # => #<Date: 2017-09-20 ...>
//}

• Date

Dir.empty?(path_name) -> bool (18322.0)

• 3.2

• 特異メソッド

path_name で与えられたディレクトリが空の場合に真を返します。 ディレクトリでない場合や空でない場合に偽を返します。

path_name で与えられたディレクトリが空の場合に真を返します。
ディレクトリでない場合や空でない場合に偽を返します。

//emlist[例][ruby]{
Dir.empty?('.') #=> false
Dir.empty?(IO::NULL) #=> false
require 'tmpdir'
Dir.mktmpdir { |dir| Dir.empty?(dir) } #=> true
//}

@param path_name 確認したいディレクトリ名。

• Dir

絞り込み条件を変える

ENV.each_key -> Enumerator (18322.0)

• 3.2

• 特異メソッド

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

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

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

• ENV

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

• 3.2

• 特異メソッド

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

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

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

• ENV

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

• 3.2

• 特異メソッド

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

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

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

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

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


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

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

p a #=> :foo
//}

• Fiber

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

• 3.2

• 特異メソッド

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

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

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

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

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

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

//emlist[...

• File

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

• 3.2

• 特異メソッド

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

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

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

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

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

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

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

• Errno::EXXX
• File

絞り込み条件を変える

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

• 3.2

• 特異メソッド

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

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

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

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

• Gem::Specification
• IO

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

• 3.2

• 特異メソッド

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

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

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

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

• Hash

IO.sysopen(path, mode = "r", perm = 0666) -> Integer (18322.0)

• 3.2

• 特異メソッド

path で指定されるファイルをオープンし、ファイル記述子を返しま す。

path で指定されるファイルをオープンし、ファイル記述子を返しま
す。

IO.for_fd などで IO オブジェクトにしない限り、このメソッ
ドでオープンしたファイルをクローズする手段はありません。

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

@param mode モードを文字列か定数の論理和で指定します。Kernel.#open と同じです。

@param perm open(2) の第 3 引数のように、ファイルを生成する場合の
ファイルのパーミッションを整数で指定します。Kernel.#open と同じです。

@raise Er...

• IO

Integer.try_convert(obj) -> Integer | nil (18322.0)

• 3.2

• 特異メソッド

obj を Integer に変換しようと試みます。変換には Object#to_int メソッドが使われます。

obj を Integer に変換しようと試みます。変換には Object#to_int
メソッドが使われます。

Integer ならそのままobjを返します。
そうでなければ obj.to_int の結果を返すか、nil が返されます。

@param obj 変換する任意のオブジェクト
@return Integer または nil
@raise TypeError to_int が Integer を返さなかった場合に発生します。

//emlist[例][ruby]{
Integer.try_convert(1) # => 1
Integer.try_conve...

• Integer

Matrix.empty(row_size=0, column_size=0) -> Matrix (18322.0)

• 3.2

• 特異メソッド

要素を持たない行列を返します。

要素を持たない行列を返します。

「要素を持たない」とは、行数もしくは列数が0の行列のことです。

row_size 、 column_size のいずれか一方は0である必要があります。

//emlist[例][ruby]{
require 'matrix'
m = Matrix.empty(2, 0)
m == Matrix[ [], [] ]
# => true
n = Matrix.empty(0, 3)
n == Matrix.columns([ [], [], [] ])
# => true
m * n
# => Matrix[[0, 0, 0], [0, 0, 0]]
//}

...

• Matrix

絞り込み条件を変える

Net::HTTPResponse.body_permitted? -> bool (18322.0)

• 3.2

• 特異メソッド

エンティティボディを含むことが許されているレスポンスクラス ならば真を、そうでなければ偽を返します。

エンティティボディを含むことが許されているレスポンスクラス
ならば真を、そうでなければ偽を返します。

//emlist[例][ruby]{
require 'net/http'

Net::HTTPSuccess.body_permitted? # => true
Net::HTTPNotModified.body_permitted? # => false
//}

• Net::HTTPResponse

REXML::Document.entity_expansion_limit -> Integer (18322.0)

• 3.2

• 特異メソッド

実体参照の展開回数の上限を返します。

実体参照の展開回数の上限を返します。

XML 文書(REXML::Document)ごとの展開回数がこの値を越えると
例外を発生させ、処理を中断します。

実体参照の展開処理を使った DoS 攻撃に対抗するための
仕組みです。

デフォルトは 10000 です。

このメソッドは Ruby 2.1 から deprecated になりました。
REXML::Security.entity_expansion_limit を使ってください。

@see REXML::Document.entity_expansion_limit=

• REXML::Document

REXML::Document.entity_expansion_limit=(val) (18322.0)

• 3.2

• 特異メソッド

実体参照の展開回数の上限を指定します。

実体参照の展開回数の上限を指定します。

XML 文書(REXML::Document)ごとの展開回数がこの値を越えると
例外を発生させ、処理を中断します。

デフォルトは 10000 です。

このメソッドは Ruby 2.1 から deprecated になりました。
REXML::Security.entity_expansion_limit= を使ってください。

@param val 設定する上限値(整数)
@see REXML::Document.entity_expansion_limit

• REXML::Document

REXML::Security.entity_expansion_text_limit -> Integer (18322.0)

• 3.2

• 特異メソッド

実体参照の展開による文字列の増分(テキストのバイト数)の 最大値を指定します。

実体参照の展開による文字列の増分(テキストのバイト数)の
最大値を指定します。

展開によって増分値がこの値を越えると
例外を発生させ、処理を中断します。

実体参照の展開処理を使った DoS 攻撃に対抗するための
仕組みです。

デフォルトは 10240 (byte) です。

@see REXML::Document.entity_expansion_text_limit=,
http://www.ruby-lang.org/ja/news/2013/02/22/rexml-dos-2013-02-22/

• REXML::Security

REXML::Security.entity_expansion_text_limit=(val) (18322.0)

• 3.2

• 特異メソッド

実体参照の展開による文字列の増分(テキストのバイト数)の 最大値を指定します。

実体参照の展開による文字列の増分(テキストのバイト数)の
最大値を指定します。

展開によって増分値がこの値を越えると
例外を発生させ、処理を中断します。

実体参照の展開処理を使った DoS 攻撃に対抗するための
仕組みです。

デフォルトは 10240 (byte) です。

@see REXML::Document.entity_expansion_text_limit
http://www.ruby-lang.org/ja/news/2013/02/22/rexml-dos-2013-02-22/

• REXML::Security

絞り込み条件を変える

Random.bytes(size) -> String (18322.0)

• 3.2

• 特異メソッド

ランダムなバイナリー文字列を返します。結果の文字列のサイズを指定できます。

ランダムなバイナリー文字列を返します。結果の文字列のサイズを指定できます。

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

//emlist[][ruby]{
Random.bytes(10) # => "\xAC\n\x7F\x8C/\xAA\xC4\x97u\xA6"
//}

@see Random#bytes

• Random

Regexp.try_convert(obj) -> Regexp | nil (18322.0)

• 3.2

• 特異メソッド

obj を to_regexp メソッドで Regexp オブジェクトに変換しようと 試みます。

obj を to_regexp メソッドで Regexp オブジェクトに変換しようと
試みます。

変換に成功した場合はそれを返し、失敗時には nil を返します。

//emlist[例][ruby]{
Regexp.try_convert(/re/) # => /re/
Regexp.try_convert("re") # => nil
//}

• Regexp

String.try_convert(obj) -> String | nil (18322.0)

• 3.2

• 特異メソッド

obj を String に変換しようと試みます。変換には Object#to_str メソッ ドが使われます。変換後の文字列を返すか、何らかの理由により変換できなかっ た場合は nil が返されます。

obj を String に変換しようと試みます。変換には Object#to_str メソッ
ドが使われます。変換後の文字列を返すか、何らかの理由により変換できなかっ
た場合は nil が返されます。

@param obj 変換する任意のオブジェクト
@return 変換後の文字列または nil

//emlist[例][ruby]{
String.try_convert("str") # => "str"
String.try_convert(/re/) # => nil
//}

• String

Struct.keyword_init? -> bool | nil (18322.0)

• 3.2

• 特異メソッド

(このメソッドは Struct の下位クラスにのみ定義されています) 構造体が作成されたときに keyword_init: true を指定されていたら true を返します。 false を指定されていたら false を返します。 それ以外の場合は nil を返します。

(このメソッドは Struct の下位クラスにのみ定義されています)
構造体が作成されたときに keyword_init: true を指定されていたら true を返します。
false を指定されていたら false を返します。
それ以外の場合は nil を返します。

//emlist[例][ruby]{
Foo = Struct.new(:a)
Foo.keyword_init? # => nil
Bar = Struct.new(:a, keyword_init: true)
Bar.keyword_init? # => true
Baz = Struct.new(:a, key...

• Struct

TSort.each_strongly_connected_component(each_node, each_child) -> Enumerator (18322.0)

• 3.2

• 特異メソッド

TSort.strongly_connected_components メソッドのイテレータ版です。

TSort.strongly_connected_components メソッドのイテレータ版です。

引数 each_node と each_child でグラフを表します。

@param each_node グラフ上の頂点をそれぞれ評価するcallメソッドを持つオブ
ジェクトを指定します。

@param each_child 引数で与えられた頂点の子をそれぞれ評価するcallメソッ
ドを持つオブジェクトを指定します。

//emlist[使用例][ruby]{
require 'tsort'

g = {1=>[2...

• TSort

絞り込み条件を変える

TSort.each_strongly_connected_component(each_node, each_child) {|nodes| ...} -> nil (18322.0)

• 3.2

• 特異メソッド

TSort.strongly_connected_components メソッドのイテレータ版です。

TSort.strongly_connected_components メソッドのイテレータ版です。

引数 each_node と each_child でグラフを表します。

@param each_node グラフ上の頂点をそれぞれ評価するcallメソッドを持つオブ
ジェクトを指定します。

@param each_child 引数で与えられた頂点の子をそれぞれ評価するcallメソッ
ドを持つオブジェクトを指定します。

//emlist[使用例][ruby]{
require 'tsort'

g = {1=>[2...

• TSort

TSort.each_strongly_connected_component_from(node, each_child, id_map={}, stack=[]) -> Enumerator (18322.0)

• 3.2

• 特異メソッド

node から到達可能な強連結成分についてのイテレータです。

node から到達可能な強連結成分についてのイテレータです。

引数 node と each_child でグラフを表します。

返す値は規定されていません。

TSort.each_strongly_connected_component_fromはTSortをincludeして
グラフを表現する必要のないクラスメソッドです。

@param node ノードを指定します。

@param each_child 引数で与えられた頂点の子をそれぞれ評価するcallメソッ
ドを持つオブジェクトを指定します。

//emlist[使用例][ruby]{
req...

• TSort

TSort.each_strongly_connected_component_from(node, each_child, id_map={}, stack=[]) {|nodes| ...} -> () (18322.0)

• 3.2

• 特異メソッド

node から到達可能な強連結成分についてのイテレータです。

node から到達可能な強連結成分についてのイテレータです。

引数 node と each_child でグラフを表します。

返す値は規定されていません。

TSort.each_strongly_connected_component_fromはTSortをincludeして
グラフを表現する必要のないクラスメソッドです。

@param node ノードを指定します。

@param each_child 引数で与えられた頂点の子をそれぞれ評価するcallメソッ
ドを持つオブジェクトを指定します。

//emlist[使用例][ruby]{
req...

• TSort

TSort.strongly_connected_components(each_node, each_child) -> Array (18322.0)

• 3.2

• 特異メソッド

強連結成分の集まりを配列の配列として返します。 この配列は子から親に向かってソートされています。 各要素は強連結成分を表す配列です。

強連結成分の集まりを配列の配列として返します。
この配列は子から親に向かってソートされています。
各要素は強連結成分を表す配列です。

引数 each_node と each_child でグラフを表します。

@param each_node グラフ上の頂点をそれぞれ評価するcallメソッドを持つオブ
ジェクトを指定します。

@param each_child 引数で与えられた頂点の子をそれぞれ評価するcallメソッ
ドを持つオブジェクトを指定します。

//emlist[使用例][ruby]{
require 'ts...

• TSort

WIN32OLE_VARIANT.array(dims, vt) -> WIN32OLE_VARIANT (18322.0)

• 3.2

• 特異メソッド

配列用のVARIANTオブジェクトを生成します。

配列用のVARIANTオブジェクトを生成します。

オートメーションメソッド呼び出し用の配列を生成します。なお、OLEオートメー
ションの配列の次元と添え字の関係はVB型だという点に注意してください。こ
れはCと逆順の並びです。

@param dims 各次元の要素数を示す配列を与えます。たとえば4要素のベクター
であれば[4]、各3要素の2次元配列であれば[3, 3]とします。
@param vt 配列要素の型をWIN32OLE::VARIANTの定数で指定します。
@return 指定された次元/要素数を持つWIN32OLE_VARIANTオブジェクト。

次の例...

• WIN32OLE::VARIANT
• WIN32OLE_VARIANT

絞り込み条件を変える

RubyVM::InstructionSequence.disasm(body) -> String (18304.0)

• 3.2

• 特異メソッド

引数 body で指定したオブジェクトから作成した RubyVM::InstructionSequence オブジェクトを人間が読める形式の文字 列に変換して返します。

引数 body で指定したオブジェクトから作成した
RubyVM::InstructionSequence オブジェクトを人間が読める形式の文字
列に変換して返します。

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

例1:Proc オブジェクトを指定した場合

# /tmp/proc.rb
p = proc { num = 1 + 2 }
puts RubyVM::InstructionSequence.disasm(p)

出力:

== disasm: <RubyVM::InstructionSequence:block in <main...

• Method
• Proc
• RubyVM::InstructionSequence

RubyVM::InstructionSequence.disassemble(body) -> String (18304.0)

• 3.2

• 特異メソッド

引数 body で指定したオブジェクトから作成した RubyVM::InstructionSequence オブジェクトを人間が読める形式の文字 列に変換して返します。

引数 body で指定したオブジェクトから作成した
RubyVM::InstructionSequence オブジェクトを人間が読める形式の文字
列に変換して返します。

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

例1:Proc オブジェクトを指定した場合

# /tmp/proc.rb
p = proc { num = 1 + 2 }
puts RubyVM::InstructionSequence.disasm(p)

出力:

== disasm: <RubyVM::InstructionSequence:block in <main...

• Method
• Proc
• RubyVM::InstructionSequence

RubyVM::InstructionSequence.compile_option -> Hash (18022.0)

• 3.2

• 特異メソッド

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

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

//emlist[例][ruby]{
require "pp"
pp RubyVM::InstructionSequence.compile_option

# => {:inline_const_cache=>true,
# :peephole_optimization=>true,
# :tailcall_optimization=>false,
# :specialized_instruction=>true,
# :operands_unification=>true,
# :instructi...

• RubyVM::InstructionSequence

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

• 3.2

• 特異メソッド

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

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

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

• RubyVM::InstructionSequence

RubyVM::MJIT.enabled? -> bool (18004.0)

• 3.2

• 特異メソッド

JIT が有効かどうかを返します。

JIT が有効かどうかを返します。

@see RubyVM::MJIT.pause, RubyVM::MJIT.resume

• RubyVM::MJIT

絞り込み条件を変える

RubyVM::MJIT.pause(wait: true) -> bool (18004.0)

• 3.2

• 特異メソッド

MJIT を一時停止します。

MJIT を一時停止します。

@param wait 真のときは JIT キューが空になるまで待ちます。
@return 停止したときは true を、すでに停止していたときは false を返します。
@raise RuntimeError JIT が有効ではないときに発生します。

@see RubyVM::MJIT.enabled?, RubyVM::MJIT.resume

• RubyVM::MJIT

RubyVM::MJIT.resume -> bool (18004.0)

• 3.2

• 特異メソッド

RubyVM::MJIT.pause で一時停止した JIT を再開します。

RubyVM::MJIT.pause で一時停止した JIT を再開します。

@return 再開したときは true を、すでに動いているときは false を返します。
@raise RuntimeError JIT が有効ではないときに発生します。
@raise RuntimeError JIT の再開に失敗した時に発生します。

@see RubyVM::MJIT.enabled?, RubyVM::MJIT.pause

• RubyVM::MJIT

Psych::Visitors::YAMLTree.new(options = {}, emitter = Psych::TreeBuilder.new, ss = Psych::ScalarScanner.new) -> Psych::Visitors::YAMLTree (9922.0)

• 3.2

• 特異メソッド

YAMLTree オブジェクトを生成します。

YAMLTree オブジェクトを生成します。

options には構築される YAML AST に設定されるオプション設定を指定します。
Psych.dump と同じオプションが指定できます。

emitter には AST の構築に使われる Psych::TreeBuilder オブジェクト
を渡します。

ss は Ruby の String が YAML document 上で quote が必要かどうか
を判定するための Psych::ScalarScanner オブジェクトを渡します。

emitter, ss は通常デフォルトのものから変える必要はないでしょう。

@param...

• Psych::ScalarScanner
• Psych::TreeBuilder
• Psych::Visitors::YAMLTree
• String

Syslog::Logger.new(program_name = &#39;ruby&#39;) -> Syslog::Logger (9607.0)

• 3.2

• 特異メソッド

Syslog::Logger オブジェクトを初期化します。

Syslog::Logger オブジェクトを初期化します。

@param program_name Logger との互換性のために用意されています。
プログラム名を文字列で指定できますが、最初の
Syslog::Logger の初期化時のみ、指定した値がセッ
トされます(syslog の仕様で 1 つのプログラム名のみが
採用されます)。

• Logger
• Syslog::Logger

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

• 3.2

• 特異メソッド

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

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

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

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

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

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

//emlist[permitte...

• Psych
• Psych::SyntaxError
• Symbol

絞り込み条件を変える

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

• 3.2

• 特異メソッド

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

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

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

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

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

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

//emlist[permitte...

• Psych
• Psych::SyntaxError
• Symbol

Psych.load_stream(yaml, filename=nil) -> [object] (9424.0)

• 3.2

• 特異メソッド

複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。

複数の YAML ドキュメントを含むデータを
Ruby のオブジェクトに変換します。

ブロックなしの場合はオブジェクトの配列を返します。

//emlist[例][ruby]{
Psych.load_stream("--- foo\n...\n--- bar\n...") # => ['foo', 'bar']
//}

ブロックありの場合は各オブジェクト引数としてそのブロックを呼び出します。

//emlist[例][ruby]{
list = []
Psych.load_stream("--- foo\n...\n--- bar\n...") do |ruby|
list << ru...

• Psych
• Psych::SyntaxError

Psych.load_stream(yaml, filename=nil) {|obj| ... } -> () (9424.0)

• 3.2

• 特異メソッド

複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。

複数の YAML ドキュメントを含むデータを
Ruby のオブジェクトに変換します。

ブロックなしの場合はオブジェクトの配列を返します。

//emlist[例][ruby]{
Psych.load_stream("--- foo\n...\n--- bar\n...") # => ['foo', 'bar']
//}

ブロックありの場合は各オブジェクト引数としてそのブロックを呼び出します。

//emlist[例][ruby]{
list = []
Psych.load_stream("--- foo\n...\n--- bar\n...") do |ruby|
list << ru...

• Psych
• Psych::SyntaxError

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

• 3.2

• 特異メソッド

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

Array.new(size) {|index| ... } -> Array (9346.0)

• 3.2

• 特異メソッド

長さ size の配列を生成し、各要素のインデックスを引数としてブロックを実行し、 各要素の値をブロックの評価結果に設定します。

長さ size の配列を生成し、各要素のインデックスを引数としてブロックを実行し、
各要素の値をブロックの評価結果に設定します。

ブロックは要素毎に実行されるので、全要素をあるオブジェクトの複製にすることができます。

@param size 配列の長さを数値で指定します。

//emlist[例][ruby]{
ary = Array.new(3){|index| "hoge#{index}"}
p ary #=> ["hoge0", "hoge1", "hoge2"]
//}

//emlist[例][ruby]{
ary = Array.ne...

• Array

絞り込み条件を変える

Array.new(ary) -> Array (9331.0)

• 3.2

• 特異メソッド

指定された配列 ary を複製して返します。 Array#dup 同様 要素を複製しない浅い複製です。

指定された配列 ary を複製して返します。
Array#dup 同様 要素を複製しない浅い複製です。

@param ary 複製したい配列を指定します。

//emlist[例][ruby]{
p Array.new([1,2,3]) # => [1,2,3]

a = ["a", "b", "c"]
b = Array.new(a)
a.each{|s| s.capitalize! }
p a #=> ["A", "B", "C"]
p b #=> ["A", "B", "C"] (b は ...

• Array

Array.new(size = 0, val = nil) -> Array (9331.0)

• 3.2

• 特異メソッド

長さ size の配列を生成し、各要素を val で初期化して返します。

長さ size の配列を生成し、各要素を val で初期化して返します。

要素毎に val が複製されるわけではないことに注意してください。
全要素が同じオブジェクト val を参照します。
後述の例では、配列の各要素は全て同一の文字列を指します。

@param size 配列の長さを数値で指定します。

@param val 配列の要素の値を指定します。

//emlist[例][ruby]{
ary = Array.new(3, "foo")
p ary #=> ["foo", "foo", "foo"]
ary[0].capitalize!
...

• Array

Array.[](*item) -> Array (9322.0)

• 3.2

• 特異メソッド

引数 item を要素として持つ配列を生成して返します。

引数 item を要素として持つ配列を生成して返します。

Array のサブクラスを作成したしたときに、そのサブクラスのインスタンスを作成
しやすくするために用意されている。

@param item 配列の要素を指定します。

//emlist[例][ruby]{
Array[1, 2, 3] #=> [1, 2, 3]

class SubArray < Array
# ...
end
p SubArray[1, 2, 3] # => [1, 2, 3]
//}

• Array

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

• 3.2

• 特異メソッド

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

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

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

class Enumerator::...

• Enumerator::Lazy

KeyError.new(error_message = "") -> KeyError (9322.0)

• 3.2

• 特異メソッド

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

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

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

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

//emlist[例][ruby]{
h = {foo: 1}
err = KeyError.new("Message", receiver: h, key: :bar)
p err.message # => "Message"
p err.receiver # => {:foo=>1}
p err.key # => :ba...

• KeyError

絞り込み条件を変える

KeyError.new(error_message = "", key:) -> KeyError (9322.0)

• 3.2

• 特異メソッド

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

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

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

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

//emlist[例][ruby]{
h = {foo: 1}
err = KeyError.new("Message", receiver: h, key: :bar)
p err.message # => "Message"
p err.receiver # => {:foo=>1}
p err.key # => :ba...

• KeyError

KeyError.new(error_message = "", receiver:) -> KeyError (9322.0)

• 3.2

• 特異メソッド

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

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

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

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

//emlist[例][ruby]{
h = {foo: 1}
err = KeyError.new("Message", receiver: h, key: :bar)
p err.message # => "Message"
p err.receiver # => {:foo=>1}
p err.key # => :ba...

• KeyError

KeyError.new(error_message = "", receiver:, key:) -> KeyError (9322.0)

• 3.2

• 特異メソッド

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

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

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

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

//emlist[例][ruby]{
h = {foo: 1}
err = KeyError.new("Message", receiver: h, key: :bar)
p err.message # => "Message"
p err.receiver # => {:foo=>1}
p err.key # => :ba...

• KeyError

Psych.parse(yaml, filename = nil) -> Psych::Nodes::Document (9322.0)

• 3.2

• 特異メソッド

YAML ドキュメントをパースし、YAML の AST を返します。

YAML ドキュメントをパースし、YAML の AST を返します。

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

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

AST については Psych::Nodes を参照してください。

@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたと...

• Psych
• Psych::Nodes
• Psych::SyntaxError

Psych.parse_stream(yaml) -> Psych::Nodes::Stream (9322.0)

• 3.2

• 特異メソッド

YAML ドキュメントをパースします。 yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。

YAML ドキュメントをパースします。
yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。

ブロックなしの場合は YAML の AST (すべての YAML ドキュメントを
保持した Psych::Nodes::Stream オブジェクト)を返します。

ブロック付きの場合は、そのブロックに最初の YAML ドキュメント
の Psych::Nodes::Document オブジェクトが渡されます。
この場合の返り値には意味がありません。


@see Psych::Nodes

//emlist[例][ruby]{
Psych.parse_stream("--...

• Psych
• Psych::Nodes
• Psych::Nodes::Stream

絞り込み条件を変える

Psych.parse_stream(yaml) {|node| ... } -> () (9322.0)

• 3.2

• 特異メソッド

YAML ドキュメントをパースします。 yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。

YAML ドキュメントをパースします。
yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。

ブロックなしの場合は YAML の AST (すべての YAML ドキュメントを
保持した Psych::Nodes::Stream オブジェクト)を返します。

ブロック付きの場合は、そのブロックに最初の YAML ドキュメント
の Psych::Nodes::Document オブジェクトが渡されます。
この場合の返り値には意味がありません。


@see Psych::Nodes

//emlist[例][ruby]{
Psych.parse_stream("--...

• Psych
• Psych::Nodes
• Psych::Nodes::Stream

WIN32OLE_TYPE.ole_classes(libname) -> [WIN32OLE_TYPE] (9322.0)

• 3.2

• 特異メソッド

TypeLibで定義されているすべての型情報を取得します。

TypeLibで定義されているすべての型情報を取得します。

@param libname 生成するTypeLibのレジストリ上のドキュメント文字列
（WIN32OLE_TYPELIB#name）または
GUID（WIN32OLE_TYPELIB#guid）またはTLBファイル名を
文字列で指定します。
@return TypeLibに格納されているすべての型をWIN32OLE_TYPEオブジェクトの配列として返します。
@raise WIN32OLERuntimeError 引数で指定したTypeLibが...

• WIN32OLE_TYPE
• WIN32OLE_TYPELIB

Psych.dump(o, io, options = {}) -> () (9070.0)

• 3.2

• 特異メソッド

Ruby のオブジェクト o を YAML ドキュメントに変換します。

Ruby のオブジェクト o を YAML ドキュメントに変換します。

io に IO オブジェクトを指定した場合は、変換されたドキュメントが
その IO に書き込まれます。
指定しなかった場合は変換されたドキュメントが文字列としてメソッドの返り値と
なります。

options で出力に関するオプションを以下の指定できます。

: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文字列で指定します
: :header
出力にヘッダを付けるかどうかを真偽値で指定します
: :indentation
イン...

• Psych

Psych.dump(o, options = {}) -> String (9070.0)

• 3.2

• 特異メソッド

Ruby のオブジェクト o を YAML ドキュメントに変換します。

Ruby のオブジェクト o を YAML ドキュメントに変換します。

io に IO オブジェクトを指定した場合は、変換されたドキュメントが
その IO に書き込まれます。
指定しなかった場合は変換されたドキュメントが文字列としてメソッドの返り値と
なります。

options で出力に関するオプションを以下の指定できます。

: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文字列で指定します
: :header
出力にヘッダを付けるかどうかを真偽値で指定します
: :indentation
イン...

• Psych

Psych.load_file(filename) -> object (9052.0)

• 3.2

• 特異メソッド

filename で指定したファイルを YAML ドキュメントとして Ruby のオブジェクトに変換します。

filename で指定したファイルを YAML ドキュメントとして
Ruby のオブジェクトに変換します。

@param filename ファイル名
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します

• Psych

絞り込み条件を変える

Psych.to_json(o) -> String (9052.0)

• 3.2

• 特異メソッド

Ruby のオブジェクト o を JSON の文字列に変換します。

Ruby のオブジェクト o を JSON の文字列に変換します。

@param o 変換対象となるオブジェクト

• Psych

PTY.check(pid, raise = false) -> Process::Status | nil (9022.0)

• 3.2

• 特異メソッド

pid で指定された子プロセスの状態をチェックし、変化があれば変化したステータスを 返します。実行中、あるいは変化なしであれば nil を返します。

pid で指定された子プロセスの状態をチェックし、変化があれば変化したステータスを
返します。実行中、あるいは変化なしであれば nil を返します。

状態が変化した後、その状態を取得することは一回しかできない（くりかえし check を
呼んだら nil が返ってくる）ので注意してください。

状態が変化して、終了したか停止した場合、第二引数が偽であれば、
対応する Process::Status オブジェクトを返します。

@param pid チェックしたい子プロセスの PID を指定します。

@param raise 真を指定すると、子プロセスが終了または停止していた場合、
...

• PTY
• Process::Status

PrettyPrint.format(output = &#39;&#39;, maxwidth = 79, newline = "\n", genspace = lambda{|n| &#39; &#39; * n}) {|pp| ...} -> object (9022.0)

• 3.2

• 特異メソッド

PrettyPrint オブジェクトを生成し、それを引数としてブロックを実行します。 与えられた output を返します。

PrettyPrint オブジェクトを生成し、それを引数としてブロックを実行します。
与えられた output を返します。

以下と同じ働きをするもので簡便のために用意されています。

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

begin
pp = PrettyPrint.new(output, maxwidth, newline, &genspace)
...
pp.flush
output
end
//}

@param output 出力先を指定します。output は << メソッドを持っていなければなりません。

@param...

• PrettyPrint
• Proc

Psych.dump_stream(*objects) -> String (9022.0)

• 3.2

• 特異メソッド

オブジェクト列を YAML ドキュメント列に変換します。

オブジェクト列を YAML ドキュメント列に変換します。

@param objects 変換対象のオブジェクト列

//emlist[例][ruby]{
Psych.dump_stream("foo\n ", {}) # => "--- ! \"foo\\n \"\n--- {}\n"
//}

• Psych

REXML::Entity.matches?(string) -> bool (9022.0)

• 3.2

• 特異メソッド

string が実体宣言の文法に従う文字列であれば真を返します。

string が実体宣言の文法に従う文字列であれば真を返します。

@param string 判定対象の文字列

//emlist[][ruby]{
require 'rexml/document'

p REXML::Entity.matches?('<!ENTITY s "seal">') # => true
p REXML::Entity.matches?('<!ENTITY % s "seal">') # => true
p REXML::Entity.matches?('<!ELEMENT br EMPTY >') # => false
//}

• REXML::Entity

絞り込み条件を変える

SystemCallError.===(other) -> bool (9022.0)

• 3.2

• 特異メソッド

other が SystemCallError のサブクラスのインスタンスで、 かつ、other.errno の値が self::Errno と同じ場合に真を返します。そうでない場合は偽を返します。

other が SystemCallError のサブクラスのインスタンスで、
かつ、other.errno の値が self::Errno と同じ場合に真を返します。そうでない場合は偽を返します。

従って、特に other が self.kind_of?(other) である場合には Module#=== と同様に真を返します。
その他に、 Errno::EXXX::Errno == Errno::EYYY::Errno である場合にも Errno::EXXX == Errno::EYYY.new は真を返します。

エラー名は異なるがエラーコードは同じであるような Errno::EXX...

• SystemCallError

Net::HTTP.start(address, port = 80, proxy_addr = :ENV, proxy_port = nil, proxy_user=nil, proxy_pass=nil) -> Net::HTTP (1222.0)

• 3.2

• 特異メソッド

新しい Net::HTTP オブジェクトを生成し、 TCP コネクション、 HTTP セッションを開始します。

新しい Net::HTTP オブジェクトを生成し、
TCP コネクション、 HTTP セッションを開始します。

ブロックを与えた場合には生成したオブジェクトをそのブロックに
渡し、ブロックが終わったときに接続を閉じます。このときは
ブロックの値を返り値とします。

ブロックを与えなかった場合には生成したオブジェクトを渡します。
利用後にはこのオブジェクトを Net::HTTP#finish してください。

proxy_addr に :ENV を指定すると環境変数 http_proxy からプロクシの URI を
取り出し利用します。環境変数 http_proxy が定義されていない場合に...

• Net::HTTP

Net::HTTP.start(address, port = 80, proxy_addr = :ENV, proxy_port = nil, proxy_user=nil, proxy_pass=nil) {|http| .... } -> object (1222.0)

• 3.2

• 特異メソッド

新しい Net::HTTP オブジェクトを生成し、 TCP コネクション、 HTTP セッションを開始します。

新しい Net::HTTP オブジェクトを生成し、
TCP コネクション、 HTTP セッションを開始します。

ブロックを与えた場合には生成したオブジェクトをそのブロックに
渡し、ブロックが終わったときに接続を閉じます。このときは
ブロックの値を返り値とします。

ブロックを与えなかった場合には生成したオブジェクトを渡します。
利用後にはこのオブジェクトを Net::HTTP#finish してください。

proxy_addr に :ENV を指定すると環境変数 http_proxy からプロクシの URI を
取り出し利用します。環境変数 http_proxy が定義されていない場合に...

• Net::HTTP

Struct.new(*args, keyword_init: nil) -> Class (1063.0)

• 3.2

• 特異メソッド

Struct クラスに新しいサブクラスを作って、それを返します。

Struct クラスに新しいサブクラスを作って、それを返します。

サブクラスでは構造体のメンバに対するアクセスメソッドが定義されています。

//emlist[例][ruby]{
dog = Struct.new("Dog", :name, :age)
fred = dog.new("fred", 5)
fred.age = 6
printf "name:%s age:%d", fred.name, fred.age
#=> "name:fred age:6" を出力します
//}

実装の都合により、クラス名の省略は後づけの機能でした。
メンバ名に String を指定できるのは後方互換...

• String
• Struct
• Symbol

Struct.new(*args, keyword_init: nil) {|subclass| block } -> Class (1063.0)

• 3.2

• 特異メソッド

Struct クラスに新しいサブクラスを作って、それを返します。

Struct クラスに新しいサブクラスを作って、それを返します。

サブクラスでは構造体のメンバに対するアクセスメソッドが定義されています。

//emlist[例][ruby]{
dog = Struct.new("Dog", :name, :age)
fred = dog.new("fred", 5)
fred.age = 6
printf "name:%s age:%d", fred.name, fred.age
#=> "name:fred age:6" を出力します
//}

実装の都合により、クラス名の省略は後づけの機能でした。
メンバ名に String を指定できるのは後方互換...

• String
• Struct
• Symbol

絞り込み条件を変える

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

• 3.2

• 特異メソッド

引数で指定した協定世界時の 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(sec, min, hour, mday, mon, year, wday, yday, isdst, zone) -> Time (907.0)

• 3.2

• 特異メソッド

引数で指定した地方時の 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.mktime(sec, min, hour, mday, mon, year, wday, yday, isdst, zone) -> Time (907.0)

• 3.2

• 特異メソッド

引数で指定した地方時の 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.utc(sec, min, hour, mday, mon, year, wday, yday, isdst, zone) -> Time (907.0)

• 3.2

• 特異メソッド

引数で指定した協定世界時の 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

URI::FTP.new(scheme, userinfo, host, port, registry, path, opaque, query, fragment, arg_check = false) -> URI::FTP (676.0)

• 3.2

• 特異メソッド

汎用的な構成要素から URI::FTP オブジェクトを生成します。build と異なり、デフォルトでは引数の正当性を検査しません。

汎用的な構成要素から URI::FTP オブジェクトを生成します。build
と異なり、デフォルトでは引数の正当性を検査しません。

例:
require 'uri'
p ftp = URI.parse("ftp://ftp.ruby-lang.org/pub/ruby/;type=d")
p ftp.typecode
#=> #<URI::FTP:0x2010029c URL:ftp://ftp.ruby-lang.org/pub/ruby/;type=d>
#=> "d"

@param scheme 構成要素を表す文字列を与えます。

@param userinfo...

• URI::FTP

絞り込み条件を変える