検索結果

RbConfig.ruby -> String (73006.0)

• 3.0

• 特異メソッド

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

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

• RbConfig

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

• 3.0

• 特異メソッド

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

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

• 3.0

• 特異メソッド

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

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

@param string パースする対象の Ruby のコードを文字列で指定します。
@raise SyntaxError string が Ruby のコードとして正しくない場合に発生します。

//emlist[][ruby]{
pp RubyVM::AbstractSyntaxTree.parse("x = 1 + 2")
# => (SCOPE@1:0-1:9
# tbl: [:x]
# args: nil
# body:
# (LASGN@1:0-1:9 :x
# ...

• RubyVM::AbstractSyntaxTree

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

• 3.0

• 特異メソッド

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

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

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

@param proc Procもしくはメソッドオブジェクトを指定します。

//emlist[][ruby]{
pp RubyVM::AbstractSyntaxTree.of(proc {1 + 2})
# => (SCOPE@2:38-2:45
# tbl: []
# args: nil
# body:
# (OPCALL@2:...

• RubyVM::AbstractSyntaxTree

Gem.ruby_engine -> String (37006.0)

• 3.0

• 特異メソッド

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

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

• Gem

絞り込み条件を変える

RubyVM::AbstractSyntaxTree.parse_file(pathname) -> RubyVM::AbstractSyntaxTree::Node (36976.0)

• 3.0

• 特異メソッド

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

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

@param pathname パースする対象のファイルパスを指定します
@raise SyntaxError pathname から取得された文字列が Ruby のコードとして正しくない場合に発生します。

//emlist[][ruby]{
pp RubyVM::AbstractSyntaxTree.parse_file(__FILE__)
# => (SCOPE@1:0-1:50
# tbl: []
# args: nil
# body:
# (F...

• RubyVM::AbstractSyntaxTree

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

• 3.0

• 特異メソッド

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

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

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

• RubyVM::InstructionSequence

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

• 3.0

• 特異メソッド

命令シーケンスのコンパイル時のデフォルトの最適化オプションを 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_file(file, options = nil) -> RubyVM::InstructionSequence (28300.0)

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

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

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

絞り込み条件を変える

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

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

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

• 3.0

• 特異メソッド

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.of(body) -> RubyVM::InstructionSequence (27904.0)

• 3.0

• 特異メソッド

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

JSON::State.from_state(options) -> JSON::State (27748.0)

• 3.0

• 特異メソッド

与えられた options によって生成した JSON::State のインスタンスを返します。

与えられた options によって生成した JSON::State のインスタンスを返します。

@param options JSON::State のインスタンスか、ハッシュを指定します。

@return options がハッシュである場合は、それによって初期化した JSON::State を
返します。options が JSON::State のインスタンスである場合は単に
options を返します。いずれでも無い場合は、何も設定されていない JSON::State の
インスタンスを返します。

//emlist[例 Hash...

• JSON::State

Date.json_create(hash) -> Date (27700.0)

• 3.0

• 特異メソッド

JSON のオブジェクトから Ruby のオブジェクトを生成して返します。

JSON のオブジェクトから Ruby のオブジェクトを生成して返します。

@param hash 適切なキーを持つハッシュを指定します。

• Date

絞り込み条件を変える

DateTime.json_create(hash) -> DateTime (27700.0)

• 3.0

• 特異メソッド

JSON のオブジェクトから Ruby のオブジェクトを生成して返します。

JSON のオブジェクトから Ruby のオブジェクトを生成して返します。

@param hash 適切なキーを持つハッシュを指定します。

• DateTime

Exception.exception(error_message = nil) -> Exception (27676.0)

• 3.0

• 特異メソッド

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

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

@param error_message エラーメッセージを表す文字列を指定します。このメッセージは
属性 Exception#message の値になり、デフォルトの例外ハンドラで表示されます。

//emlist[例][ruby]{
e = Exception.new("some message")
p e # => #<Exception: some message>
p e.message # => "some message"
//}

//emlist[例][ruby]{
e = E...

• Exception

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

• 3.0

• 特異メソッド

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

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

• 3.0

• 特異メソッド

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

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

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

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

• String
• Symbol
• TracePoint

JSON::Generator::GeneratorMethods::String::Extend.json_create(hash) -> String (27400.0)

• 3.0

• 特異メソッド

JSON のオブジェクトから Ruby の文字列を生成して返します。

JSON のオブジェクトから Ruby の文字列を生成して返します。

@param hash キーとして "raw" という文字列を持ち、その値として数値の配列を持つハッシュを指定します。

require 'json'
String.json_create({"raw" => [0x41, 0x42, 0x43]}) # => "ABC"

• JSON::Generator::GeneratorMethods::String::Extend

絞り込み条件を変える

WIN32OLE_TYPE.typelibs -> [String] (27376.0)

• 3.0

• 特異メソッド

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

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

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

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

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

• WIN32OLE_TYPE
• WIN32OLE_TYPELIB

FileUtils.options -> Array (27340.0)

• 3.0

• 特異メソッド

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

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

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

• FileUtils

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

• 3.0

• 特異メソッド

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

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

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

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

• FileUtils

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

• 3.0

• 特異メソッド

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

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

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

実体参照の展開処理を使った 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) (27340.0)

• 3.0

• 特異メソッド

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

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

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

実体参照の展開処理を使った 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

絞り込み条件を変える

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

• 3.0

• 特異メソッド

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

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

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

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

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

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

• TSort

TSort.tsort(each_node, each_child) -> Array (27340.0)

• 3.0

• 特異メソッド

頂点をトポロジカルソートして得られる配列を返します。 この配列は子から親に向かってソートされています。 すなわち、最初の要素は子を持たず、最後の要素は親を持ちません。

頂点をトポロジカルソートして得られる配列を返します。
この配列は子から親に向かってソートされています。
すなわち、最初の要素は子を持たず、最後の要素は親を持ちません。

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

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

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

@raise TSort::C...

• TSort

TSort.tsort_each(each_node, each_child) -> Enumerator (27340.0)

• 3.0

• 特異メソッド

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

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

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

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

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

@raise TSort::Cyclic 閉路が存在するとき、発生します.

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

• TSort

TSort.tsort_each(each_node, each_child) {|node| ...} -> nil (27340.0)

• 3.0

• 特異メソッド

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

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

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

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

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

@raise TSort::Cyclic 閉路が存在するとき、発生します.

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

• TSort

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

• 3.0

• 特異メソッド

引数 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 (27304.0)

• 3.0

• 特異メソッド

引数 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::MJIT.pause(wait: true) -> bool (27304.0)

• 3.0

• 特異メソッド

MJIT を一時停止します。

MJIT を一時停止します。

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

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

• RubyVM::MJIT

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

• 3.0

• 特異メソッド

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

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

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

• RubyVM::MJIT

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

• 3.0

• 特異メソッド

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

URI.extract(str) -> [String] (19084.0)

• 3.0

• 特異メソッド

文字列 str に対してパターンマッチングを試み、 絶対URIにマッチした部分文字列からなる配列として返します。 抽出する URI がなければ空の配列を返します。

文字列 str に対してパターンマッチングを試み、
絶対URIにマッチした部分文字列からなる配列として返します。
抽出する URI がなければ空の配列を返します。

第2引数に文字列の配列 schemes が与えられた場合は
そのスキームだけを検索します。

ブロックが与えられた場合は String#scan と同様で、
マッチした部分がみつかるたびに uri_str に
その部分を代入してブロックを評価します。
このときは nil を返します。

このメソッドは Ruby 2.2 から obsolete です。

@param str 文字列を与えます。

@param schemes 検...

• URI

絞り込み条件を変える

URI.extract(str) {|uri_str| ... } -> nil (19084.0)

• 3.0

• 特異メソッド

文字列 str に対してパターンマッチングを試み、 絶対URIにマッチした部分文字列からなる配列として返します。 抽出する URI がなければ空の配列を返します。

文字列 str に対してパターンマッチングを試み、
絶対URIにマッチした部分文字列からなる配列として返します。
抽出する URI がなければ空の配列を返します。

第2引数に文字列の配列 schemes が与えられた場合は
そのスキームだけを検索します。

ブロックが与えられた場合は String#scan と同様で、
マッチした部分がみつかるたびに uri_str に
その部分を代入してブロックを評価します。
このときは nil を返します。

このメソッドは Ruby 2.2 から obsolete です。

@param str 文字列を与えます。

@param schemes 検...

• URI

URI.extract(str, schemes) -> [String] (19084.0)

• 3.0

• 特異メソッド

文字列 str に対してパターンマッチングを試み、 絶対URIにマッチした部分文字列からなる配列として返します。 抽出する URI がなければ空の配列を返します。

文字列 str に対してパターンマッチングを試み、
絶対URIにマッチした部分文字列からなる配列として返します。
抽出する URI がなければ空の配列を返します。

第2引数に文字列の配列 schemes が与えられた場合は
そのスキームだけを検索します。

ブロックが与えられた場合は String#scan と同様で、
マッチした部分がみつかるたびに uri_str に
その部分を代入してブロックを評価します。
このときは nil を返します。

このメソッドは Ruby 2.2 から obsolete です。

@param str 文字列を与えます。

@param schemes 検...

• URI

URI.extract(str, schemes) {|uri_str| ... } -> nil (19084.0)

• 3.0

• 特異メソッド

文字列 str に対してパターンマッチングを試み、 絶対URIにマッチした部分文字列からなる配列として返します。 抽出する URI がなければ空の配列を返します。

文字列 str に対してパターンマッチングを試み、
絶対URIにマッチした部分文字列からなる配列として返します。
抽出する URI がなければ空の配列を返します。

第2引数に文字列の配列 schemes が与えられた場合は
そのスキームだけを検索します。

ブロックが与えられた場合は String#scan と同様で、
マッチした部分がみつかるたびに uri_str に
その部分を代入してブロックを評価します。
このときは nil を返します。

このメソッドは Ruby 2.2 から obsolete です。

@param str 文字列を与えます。

@param schemes 検...

• URI

File.utime(atime, mtime, *filename) -> Integer (18976.0)

• 3.0

• 特異メソッド

ファイルの最終アクセス時刻と更新時刻を変更します。 シンボリックリンクに対しては File.lutime　と違って、 シンボリックのリンク先を変更します。

ファイルの最終アクセス時刻と更新時刻を変更します。
シンボリックリンクに対しては File.lutime　と違って、
シンボリックのリンク先を変更します。

@param atime 最終アクセス時刻を Time か、起算時からの経過秒数を数値で指定します。

@param mtime 更新時刻を Time か、起算時からの経過秒数を数値で指定します。

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

@return 変更したファイルの数を返します。

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

//emlist[例: ...

• File
• Time

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

• 3.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

@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

絞り込み条件を変える

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

• 3.0

• 特異メソッド

クラスと 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

Gem::SourceIndex.load_specification(file_name) -> Gem::Specification | nil (18700.0)

• 3.0

• 特異メソッド

与えられたファイル名から Ruby スクリプト形式の gemspec をロードして Gem::Specification のインスタンスを返します。

与えられたファイル名から Ruby スクリプト形式の gemspec をロードして
Gem::Specification のインスタンスを返します。

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

@raise SignalException gemspec をロードしているときに発生します。

@raise SystemExit gemspec をロードしているときに発生します。

• Gem::SourceIndex
• Gem::Specification

Ripper.token_match(src, pattern) -> Ripper::TokenPattern::MatchData | nil (18700.0)

• 3.0

• 特異メソッド

Ruby プログラム src に対してパターン pattern をマッチし、 マッチデータを返します。

Ruby プログラム src に対してパターン pattern をマッチし、
マッチデータを返します。

ライブラリ内部で使用します。

• Ripper

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

• 3.0

• 特異メソッド

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

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

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

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

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

• File

CSV.instance(data = $stdout, options = Hash.new) -> CSV (18640.0)

• 3.0

• 特異メソッド

このメソッドは CSV.new のように CSV のインスタンスを返します。 しかし、返される値は Object#object_id と与えられたオプションを キーとしてキャッシュされます。

このメソッドは CSV.new のように CSV のインスタンスを返します。
しかし、返される値は Object#object_id と与えられたオプションを
キーとしてキャッシュされます。

ブロックが与えられた場合、生成されたインスタンスをブロックに渡して評価した
結果を返します。

@param data String か IO のインスタンスを指定します。

@param options CSV.new のオプションと同じオプションを指定できます。

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

options = { headers: true }

text...

• CSV
• IO
• String

絞り込み条件を変える

CSV.instance(data = $stdout, options = Hash.new) {|csv| ... } -> object (18640.0)

• 3.0

• 特異メソッド

このメソッドは CSV.new のように CSV のインスタンスを返します。 しかし、返される値は Object#object_id と与えられたオプションを キーとしてキャッシュされます。

このメソッドは CSV.new のように CSV のインスタンスを返します。
しかし、返される値は Object#object_id と与えられたオプションを
キーとしてキャッシュされます。

ブロックが与えられた場合、生成されたインスタンスをブロックに渡して評価した
結果を返します。

@param data String か IO のインスタンスを指定します。

@param options CSV.new のオプションと同じオプションを指定できます。

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

options = { headers: true }

text...

• CSV
• IO
• String

CSV.table(path, options = Hash.new) -> CSV::Table | [Array] (18640.0)

• 3.0

• 特異メソッド

以下と同等のことを行うメソッドです。

以下と同等のことを行うメソッドです。

//emlist[][ruby]{
CSV.read( path, { headers: true,
converters: :numeric,
header_converters: :symbol }.merge(options) )
//}

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

@param options CSV.new のオプションと同じオプションを指定できます。


@see CSV.read

• CSV

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

• 3.0

• 特異メソッド

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

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

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

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

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

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

• Dir

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

• 3.0

• 特異メソッド

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

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

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

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

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

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

• Dir

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

• 3.0

• 特異メソッド

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

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

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

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

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

• File

絞り込み条件を変える

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

• 3.0

• 特異メソッド

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

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

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

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

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

• File

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

• 3.0

• 特異メソッド

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

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

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

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

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

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

• Errno::EXXX
• File

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

• 3.0

• 特異メソッド

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

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

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

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

• File

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

• 3.0

• 特異メソッド

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

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

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

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

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

• File

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

• 3.0

• 特異メソッド

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

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

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

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

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

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

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

• File

絞り込み条件を変える

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

• 3.0

• 特異メソッド

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

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

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

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

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

@see IO#stat, File#lstat

• File
• File::Stat

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

• 3.0

• 特異メソッド

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

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

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

• Gem::Requirement

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

• 3.0

• 特異メソッド

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

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

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

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

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

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

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

• IO

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

• 3.0

• 特異メソッド

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

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

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

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

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

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

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

• IO

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

• 3.0

• 特異メソッド

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

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

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

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

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

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

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

• IO

絞り込み条件を変える

JSON.state -> JSON::Ext::Generator::State (18640.0)

• 3.0

• 特異メソッド

JSON ライブラリがジェネレータの状態を表すクラスとして使用するクラスを返します。

JSON ライブラリがジェネレータの状態を表すクラスとして使用するクラスを返します。

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

JSON.state # => JSON::Ext::Generator::State
//}

• JSON

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

• 3.0

• 特異メソッド

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

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

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

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

• Psych

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

• 3.0

• 特異メソッド

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

Rake.application -> Rake::Application (18640.0)

• 3.0

• 特異メソッド

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

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

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

require 'pp'

task default: :test_rake_app
task :test_rake_app do
pp Rake.application
end

# => #<Rake::Application:0x31b0f18
# @default_loader=#<Rake::DefaultLoader:0x31b0c78>,
# @imported=[],
# @last_description=nil,
# ...

• Rake

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

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

絞り込み条件を変える

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

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

File.fnmatch(pattern, path, flags = 0) -> bool (18592.0)

• 3.0

• 特異メソッド

ファイル名のパターンマッチ fnmatch(3) を行います。 path が pattern にマッチすれば真を返します。そうでない場合には false を返します。

ファイル名のパターンマッチ fnmatch(3) を行います。
path が pattern にマッチすれば真を返します。そうでない場合には false を返します。

@param pattern パターンを文字列で指定します。ワイルドカードとして `*',
`**`, `?', `[]', `{}' が使用できます。
//emlist[例][ruby]{
%w(foo foobar bar).each {|f|
p File.fnmatch("foo*", f)
}
# => true
# true
# false
//}

@param p...

• File
• File::Constants

File.fnmatch?(pattern, path, flags = 0) -> bool (18592.0)

• 3.0

• 特異メソッド

ファイル名のパターンマッチ fnmatch(3) を行います。 path が pattern にマッチすれば真を返します。そうでない場合には false を返します。

ファイル名のパターンマッチ fnmatch(3) を行います。
path が pattern にマッチすれば真を返します。そうでない場合には false を返します。

@param pattern パターンを文字列で指定します。ワイルドカードとして `*',
`**`, `?', `[]', `{}' が使用できます。
//emlist[例][ruby]{
%w(foo foobar bar).each {|f|
p File.fnmatch("foo*", f)
}
# => true
# true
# false
//}

@param p...

• File
• File::Constants

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

• 3.0

• 特異メソッド

複数の 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| ... } -> () (18544.0)

• 3.0

• 特異メソッド

複数の 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

絞り込み条件を変える

Ripper.tokenize(src, filename = &#39;-&#39;, lineno = 1, raise_errors: false) -> [String] (18472.0)

• 3.0

• 特異メソッド

Ruby プログラム str をトークンに分割し、そのリストを返します。

Ruby プログラム str をトークンに分割し、そのリストを返します。

@param src Ruby プログラムを文字列か IO オブジェクトで指定します。

@param filename src のファイル名を文字列で指定します。省略すると "-" になります。

@param lineno src の開始行番号を指定します。省略すると 1 になります。

@param raise_errors true を指定すると、src にエラーがある場合に例外(SyntaxError)を発生させます。省略すると false になります。

@raise SyntaxError raise_...

• Ripper

OptionParser.accept(klass, pat = /.*/) {|str| ...} -> () (18454.0)

• 3.0

• 特異メソッド

オプションの引数を文字列から Ruby のオブジェクトに変換するための ブロックを登録します。すべての OptionParser インスタンスに共通です。

オプションの引数を文字列から Ruby のオブジェクトに変換するための
ブロックを登録します。すべての OptionParser インスタンスに共通です。

ブロックには、文字列として与えられるオプションの引数から klass のインスタンスを生成して返すものを指定します。

OptionParser#on で klass を指定した場合、
コマンドラインのオプションに与えられた引数は、この accept で登録したブロックで
klass のインスタンスに変換されてから、OptionParser#on メソッドで登録したブロックに渡されます。

//emlist[][ruby]{
requi...

• OptionParser
• Regexp

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

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

Socket.getaddrinfo(nodename, servname, family=nil, socktype=nil, protocol=nil, flags=nil) -> Array (18448.0)

• 3.0

• 特異メソッド

2553で定義された getaddrinfo() の機能を提供するクラスメソッド。この関数は gethostbyname() や getservbyname() の代わりとして用意されており、 IP のバージョンに依存しないプログラムを書くための標準的な API です。

2553で定義された
getaddrinfo() の機能を提供するクラスメソッド。この関数は
gethostbyname() や getservbyname() の代わりとして用意されており、
IP のバージョンに依存しないプログラムを書くための標準的な API です。

@param nodename ホスト名を指定します。 必須引数です。 (lib:socket#host_formatを参照)

@param servname サービス名を指定します。 必須引数です。 (lib:socket#service_formatを参照)

@param family アドレスファミリー。Sock...

• Socket

URI.decode_www_form_component(str, enc=Encoding::UTF_8) -> String (18448.0)

• 3.0

• 特異メソッド

URL-encoded form data の文字列の各コンポーネント をデコードした文字列を返します。

URL-encoded form data の文字列の各コンポーネント
をデコードした文字列を返します。

通常は URI.decode_www_form を使うほうがよいでしょう。

"+" という文字は空白文字にデコードします。

enc で指定したエンコーディングの文字列が URL エンコードされたものと
みなし、エンコーディングを付加します。

このメソッドは
https://www.w3.org/TR/html5/sec-forms.html#urlencoded-form-data
にもとづいて実装されています。


//emlist[][ruby]{
require 'uri'
...

• URI

絞り込み条件を変える

CSV.filter(input, options = Hash.new) {|row| ... } (18412.0)

• 3.0

• 特異メソッド

このメソッドは CSV データに対して Unix のツール群のようなフィルタを構築 するのに便利です。

このメソッドは CSV データに対して Unix のツール群のようなフィルタを構築
するのに便利です。

与えられたブロックに一行ずつ渡されます。ブロックに渡された行は必要であ
れば変更することができます。ブロックの評価後に行を全て output に書き込
みます。

@param input String か IO のインスタンスを指定します。
デフォルトは ARGF です。

@param output String か IO のインスタンスを指定します。
デフォルトは $stdout です。

@param options ":in...

• CSV
• IO
• String

CSV.filter(input, output, options = Hash.new) {|row| ... } (18412.0)

• 3.0

• 特異メソッド

このメソッドは CSV データに対して Unix のツール群のようなフィルタを構築 するのに便利です。

このメソッドは CSV データに対して Unix のツール群のようなフィルタを構築
するのに便利です。

与えられたブロックに一行ずつ渡されます。ブロックに渡された行は必要であ
れば変更することができます。ブロックの評価後に行を全て output に書き込
みます。

@param input String か IO のインスタンスを指定します。
デフォルトは ARGF です。

@param output String か IO のインスタンスを指定します。
デフォルトは $stdout です。

@param options ":in...

• CSV
• IO
• String

CSV.filter(options = Hash.new) {|row| ... } (18412.0)

• 3.0

• 特異メソッド

このメソッドは CSV データに対して Unix のツール群のようなフィルタを構築 するのに便利です。

このメソッドは CSV データに対して Unix のツール群のようなフィルタを構築
するのに便利です。

与えられたブロックに一行ずつ渡されます。ブロックに渡された行は必要であ
れば変更することができます。ブロックの評価後に行を全て output に書き込
みます。

@param input String か IO のインスタンスを指定します。
デフォルトは ARGF です。

@param output String か IO のインスタンスを指定します。
デフォルトは $stdout です。

@param options ":in...

• CSV
• IO
• String

Encoding.default_external=(encoding) (18412.0)

• 3.0

• 特異メソッド

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

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

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

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

@see spec...

• Encoding
• spec/rubycmd

Encoding.default_internal=(encoding) (18412.0)

• 3.0

• 特異メソッド

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

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

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

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

@see spe...

• Encoding
• spec/rubycmd

絞り込み条件を変える

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

• 3.0

• 特異メソッド

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

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

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

nil を返します。

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

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

• GC

URI.encode_www_form_component(str, enc=nil) -> String (18412.0)

• 3.0

• 特異メソッド

文字列を URL-encoded form data の1コンポーネント としてエンコードした文字列を返します。

文字列を URL-encoded form data の1コンポーネント
としてエンコードした文字列を返します。

通常は URI.encode_www_form を使うほうがよいでしょう。

このメソッドでは *, -, ., 0-9, A-Z, _, a-z, は変換せず、
空白は + に変換し、その他は %XX に、変換します。

このメソッドは
https://www.w3.org/TR/2013/CR-html5-20130806/forms.html#url-encoded-form-data
にもとづいて実装されています。

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

• URI

Dir.exists?(file_name) -> bool (18400.0)

• 3.0

• 特異メソッド

このメソッドは Ruby 2.1 から deprecated です。Dir.exist? を使用してください。

このメソッドは Ruby 2.1 から deprecated です。Dir.exist? を使用してください。

• Dir

Exception.json_create(hash) -> Exception (18400.0)

• 3.0

• 特異メソッド

JSON のオブジェクトから Ruby のオブジェクトを生成して返します。

JSON のオブジェクトから Ruby のオブジェクトを生成して返します。

@param hash 適切なキーを持つハッシュを指定します。

• Exception

File.exists?(path) -> bool (18400.0)

• 3.0

• 特異メソッド

このメソッドは Ruby 2.1 から deprecated です。File.exist? を使用してください。

このメソッドは Ruby 2.1 から deprecated です。File.exist? を使用してください。

• File

絞り込み条件を変える

Gem::Specification.list -> Array (18400.0)

• 3.0

• 特異メソッド

実行中の Ruby のインスタンスで作成された Gem::Specification のインスタンスを返します。

実行中の Ruby のインスタンスで作成された Gem::Specification のインスタンスを返します。

• Gem::Specification

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

• 3.0

• 特異メソッド

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

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

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

• Psych

Range.json_create(hash) -> Range (18400.0)

• 3.0

• 特異メソッド

JSON のオブジェクトから Ruby のオブジェクトを生成して返します。

JSON のオブジェクトから Ruby のオブジェクトを生成して返します。

@param hash 適切なキーを持つハッシュを指定します。

• Range

Regexp.json_create(hash) -> Regexp (18400.0)

• 3.0

• 特異メソッド

JSON のオブジェクトから Ruby のオブジェクトを生成して返します。

JSON のオブジェクトから Ruby のオブジェクトを生成して返します。

@param hash 適切なキーを持つハッシュを指定します。

• Regexp

Struct.json_create(hash) -> Struct (18400.0)

• 3.0

• 特異メソッド

JSON のオブジェクトから Ruby のオブジェクトを生成して返します。

JSON のオブジェクトから Ruby のオブジェクトを生成して返します。

@param hash 適切なキーを持つハッシュを指定します。

• Struct

絞り込み条件を変える

Time.json_create(hash) -> Time (18400.0)

• 3.0

• 特異メソッド

JSON のオブジェクトから Ruby のオブジェクトを生成して返します。

JSON のオブジェクトから Ruby のオブジェクトを生成して返します。

@param hash 適切なキーを持つハッシュを指定します。

• Time

Regexp.last_match(nth) -> String | nil (18382.0)

• 3.0

• 特異メソッド

整数 nth が 0 の場合、マッチした文字列を返します ($&)。それ以外では、nth 番目の括弧にマッチ した部分文字列を返します($1,$2,...)。 対応する括弧がない場合やマッチしなかった場合には nil を返し ます。

整数 nth が 0 の場合、マッチした文字列を返します
($&)。それ以外では、nth 番目の括弧にマッチ
した部分文字列を返します($1,$2,...)。
対応する括弧がない場合やマッチしなかった場合には nil を返し
ます。

//emlist[例][ruby]{
/(.)(.)/ =~ "ab"
p Regexp.last_match # => #<MatchData:0x4599e58>
p Regexp.last_match(0) # => "ab"
p Regexp.last_match(1) # => "a"
p Regexp.last_match(2) ...

• NoMethodError
• Regexp

Coverage.line_stub(file) -> Array (18376.0)

• 3.0

• 特異メソッド

行カバレッジの配列のスタブを返します。

行カバレッジの配列のスタブを返します。

測定対象となる行の要素は 0, 空行やコメントなどにより測定対象外となる行の要素は nil となります。

//emlist[foo.rb][ruby]{
s = 0
10.times do |x|
s += x
end

if s == 45
p :ok
else
p :ng
end
//}

このファイルに対して line_stub を実行すると、次のようになります。

//emlist[][ruby]{
require "coverage"
p Coverage.line_stub("foo.rb") #=> [0, 0, 0, ...

• Coverage

Coverage.peek_result -> Hash (18376.0)

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

Coverage.start(option = {}) -> nil (18376.0)

• 3.0

• 特異メソッド

カバレッジの測定を開始します。既に実行されていた場合には何も起こりません。 ただし、カバレッジ計測中に測定対象を変更しようとした場合は、RuntimeError となります。

カバレッジの測定を開始します。既に実行されていた場合には何も起こりません。
ただし、カバレッジ計測中に測定対象を変更しようとした場合は、RuntimeError となります。

@param option カバレッジの計測モードを指定します。
:all か "all" を指定すると、全ての種類を計測します。
個別に指定する場合は、ハッシュを渡します。
詳細は、coverage ライブラリ を参照してください。

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

• Coverage

絞り込み条件を変える

Encoding.compatible?(obj1, obj2) -> Encoding | nil (18376.0)

• 3.0

• 特異メソッド

2つのオブジェクトのエンコーディングに関する互換性をチェックします。 互換性がある場合はそのエンコーディングを、 ない場合は nil を返します。

2つのオブジェクトのエンコーディングに関する互換性をチェックします。
互換性がある場合はそのエンコーディングを、
ない場合は nil を返します。

引数が両方とも文字列である場合、互換性があるならば
その文字列を結合できます。この場合返り値のエンコーディングは
結合した文字列が取るであろう Encoding オブジェクトを返します。

//emlist[例][ruby]{
Encoding.compatible?("\xa1".force_encoding("iso-8859-1"), "b")
#=> #<Encoding:ISO-8859-1>

Encoding.compatible?...

• Encoding

Encoding.default_external -> Encoding (18376.0)

• 3.0

• 特異メソッド

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

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

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

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


default_external は必ず設定されます。Encoding.locale_charmap が nil を返す場合には US-ASCII が、
ロケールにRubyが扱えないエンコーディングが指定されている場合には ASCII-8...

• Encoding
• spec/rubycmd

Exception.new(error_message = nil) -> Exception (18376.0)

• 3.0

• 特異メソッド

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

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

@param error_message エラーメッセージを表す文字列を指定します。このメッセージは
属性 Exception#message の値になり、デフォルトの例外ハンドラで表示されます。

//emlist[例][ruby]{
e = Exception.new("some message")
p e # => #<Exception: some message>
p e.message # => "some message"
//}

//emlist[例][ruby]{
e = E...

• Exception

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

• 3.0

• 特異メソッド

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

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

例:

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

• GC::Profiler
• Hash

GC::Profiler.result -> String (18376.0)

• 3.0

• 特異メソッド

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

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

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

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

• GC::Profiler

絞り込み条件を変える