検索結果

Kernel$$> -> object (37738.0)

• 2.3.0

• 変数

標準出力です。

標準出力です。

組み込み関数 Kernel.#print、Kernel.#puts や
Kernel.#p などのデフォルトの出力先となります。
初期値は Object::STDOUT です。
コマンドラインオプションオプション -i を指定した場合には
読み込み元と同じ名前のファイルを表します。

$stdout に代入するオブジェクトには
write という名前のメソッドが定義されていなければいけません。

自プロセスの標準出力をリダイレクトしたいときには、
以下のように $stdout に代入すれば十分です。

//emlist[例][ruby]{
# 標準出力の出力先を /tmp/...

• Kernel
• spec/rubycmd

Kernel$$@ -> [String] | nil (37501.0)

• 2.3.0

• 変数

最後に例外が発生した時のバックトレースを表す配列です。 Kernel.#raise によって設定されます。

最後に例外が発生した時のバックトレースを表す配列です。
Kernel.#raise によって設定されます。

配列の各要素はメソッドの呼び出し位置を示す文字列で形式は

"filename:line"

または

"filename:line:in `methodname'"

です。これは Kernel.#caller が返す値と同じ形式です。

$@ へ値を代入するときは、$! が nil であってはいけません。
$@ の値は、$!.backtrace の値と同じです。
また、$@ への代入は $!.set_backtrace 呼び出しと同じです。

文字列の配列でも nil で...

• Kernel
• TypeError

Kernel$$stdout -> object (37438.0)

• 2.3.0

• 変数

標準出力です。

標準出力です。

組み込み関数 Kernel.#print、Kernel.#puts や
Kernel.#p などのデフォルトの出力先となります。
初期値は Object::STDOUT です。
コマンドラインオプションオプション -i を指定した場合には
読み込み元と同じ名前のファイルを表します。

$stdout に代入するオブジェクトには
write という名前のメソッドが定義されていなければいけません。

自プロセスの標準出力をリダイレクトしたいときには、
以下のように $stdout に代入すれば十分です。

//emlist[例][ruby]{
# 標準出力の出力先を /tmp/...

• Kernel
• spec/rubycmd

Kernel$$-I -> [String] (37348.0)

• 2.3.0

• 変数

Rubyライブラリをロードするときの検索パスです。

Rubyライブラリをロードするときの検索パスです。

Kernel.#load や Kernel.#require
がファイルをロードする時に検索するディレクトリのリストを含む配列です。

起動時にはコマンドラインオプション -I で指定したディレクトリ、
環境変数 RUBYLIB の値、
コンパイル時に指定したデフォルト値
をこの順番で含みます。

以下に典型的な UNIX システム上でのロードパスを示します。

-I で指定したパス
環境変数 RUBYLIB の値
/usr/local/lib/ruby/site_ruby/VERSION サイト固有、バージョン依...

• Kernel
• platform/Cygwin
• platform/mingw32
• platform/mswin32
• spec/envvars
• spec/rubycmd

Kernel$$LOAD_PATH -> [String] (37348.0)

• 2.3.0

• 変数

Rubyライブラリをロードするときの検索パスです。

Rubyライブラリをロードするときの検索パスです。

Kernel.#load や Kernel.#require
がファイルをロードする時に検索するディレクトリのリストを含む配列です。

起動時にはコマンドラインオプション -I で指定したディレクトリ、
環境変数 RUBYLIB の値、
コンパイル時に指定したデフォルト値
をこの順番で含みます。

以下に典型的な UNIX システム上でのロードパスを示します。

-I で指定したパス
環境変数 RUBYLIB の値
/usr/local/lib/ruby/site_ruby/VERSION サイト固有、バージョン依...

• Kernel
• platform/Cygwin
• platform/mingw32
• platform/mswin32
• spec/envvars
• spec/rubycmd

絞り込み条件を変える

Kernel$$-i -> String | nil (37339.0)

• 2.3.0

• 変数

in-place 置換モードで用いられます。

in-place 置換モードで用いられます。

コマンドラインオプション -i を指定したとき、空文字列になります。
-i オプションに拡張子を渡した場合にはその拡張子が文字列として格納されます。

-i オプションが指定されていない時の値は nil です。

スクリプト内で $-i に代入することもでき、
その場合は Object::ARGV の次の
ファイルを読み込み始めるタイミングで in-place 置換を開始します。

この変数はグローバルスコープです。

@see spec/rubycmd

• Kernel
• spec/rubycmd

Kernel$$-0 -> String | nil (37255.0)

• 2.3.0

• 変数

入力レコード区切りを表す文字列です。 awk の RS 変数のように働きます。

入力レコード区切りを表す文字列です。
awk の RS 変数のように働きます。

Kernel.#gets のような「行」単位の読み込みメソッドが「行」の区切りとして使用します。
Rubyがコマンドオプション -0 付きで起動されたときには -0 で指定された値が既定値となります。そうでないとき、既定値は "\n" です。

この変数に nil を設定すると読み込みメソッドはファイル全体を一度に読み込みます。
空文字列 "" を設定するとパラグラフモードとみなされ、
2 つ以上連続した改行が「行」の区切りになります。

$/ には正規表現は使えません。

この変数はグローバルスコープです。
...

• Kernel
• spec/rubycmd

Kernel$$-F -> Regexp | String | nil (37255.0)

• 2.3.0

• 変数

String#split で引数を省略した場合の区切り文字です。

String#split で引数を省略した場合の区切り文字です。

Ruby 2.7からは nil 以外に変更することは非推奨になったため、
nil 以外を代入すると警告がでるようになりました。

nilを設定すると特殊な分割を行います。
詳細は String#split を参照してください。

コマンドラインオプション -F を指定して Ruby を起動した場合、
初期値は -F で指定した値です。
それ以外の時には初期値は nil です。

$; には任意のオブジェクトを代入できます。
ただし、String#split の仕様変更を考慮すると
常に正規表現を指定すべきです。

Ruby ...

• Kernel
• spec/rubycmd

Timeout.#timeout(sec, exception_class = nil) {|i| ... } -> object (28561.0)

• 2.3.0

• モジュール関数

ブロックを sec 秒の期限付きで実行します。 ブロックの実行時間が制限を過ぎたときは例外 Timeout::Error が発生します。

ブロックを sec 秒の期限付きで実行します。
ブロックの実行時間が制限を過ぎたときは例外
Timeout::Error が発生します。

exception_class を指定した場合には Timeout::Error の代わりに
その例外が発生します。
ブロックパラメータ i は sec がはいります。

また sec が 0 もしくは nil のときは制限時間なしで
ブロックを実行します。

@param sec タイムアウトする時間を秒数で指定します.
@param exception_class タイムアウトした時、発生させる例外を指定します.

例 長い計算のタイムアウト
r...

• Timeout
• Timeout::Error
• resolv-replace

Kernel$$: -> [String] (28348.0)

• 2.3.0

• 変数

Rubyライブラリをロードするときの検索パスです。

Rubyライブラリをロードするときの検索パスです。

Kernel.#load や Kernel.#require
がファイルをロードする時に検索するディレクトリのリストを含む配列です。

起動時にはコマンドラインオプション -I で指定したディレクトリ、
環境変数 RUBYLIB の値、
コンパイル時に指定したデフォルト値
をこの順番で含みます。

以下に典型的な UNIX システム上でのロードパスを示します。

-I で指定したパス
環境変数 RUBYLIB の値
/usr/local/lib/ruby/site_ruby/VERSION サイト固有、バージョン依...

• Kernel
• platform/Cygwin
• platform/mingw32
• platform/mswin32
• spec/envvars
• spec/rubycmd

絞り込み条件を変える

Kernel$$/ -> String | nil (28255.0)

• 2.3.0

• 変数

入力レコード区切りを表す文字列です。 awk の RS 変数のように働きます。

入力レコード区切りを表す文字列です。
awk の RS 変数のように働きます。

Kernel.#gets のような「行」単位の読み込みメソッドが「行」の区切りとして使用します。
Rubyがコマンドオプション -0 付きで起動されたときには -0 で指定された値が既定値となります。そうでないとき、既定値は "\n" です。

この変数に nil を設定すると読み込みメソッドはファイル全体を一度に読み込みます。
空文字列 "" を設定するとパラグラフモードとみなされ、
2 つ以上連続した改行が「行」の区切りになります。

$/ には正規表現は使えません。

この変数はグローバルスコープです。
...

• Kernel
• spec/rubycmd

Kernel$$; -> Regexp | String | nil (28255.0)

• 2.3.0

• 変数

String#split で引数を省略した場合の区切り文字です。

String#split で引数を省略した場合の区切り文字です。

Ruby 2.7からは nil 以外に変更することは非推奨になったため、
nil 以外を代入すると警告がでるようになりました。

nilを設定すると特殊な分割を行います。
詳細は String#split を参照してください。

コマンドラインオプション -F を指定して Ruby を起動した場合、
初期値は -F で指定した値です。
それ以外の時には初期値は nil です。

$; には任意のオブジェクトを代入できます。
ただし、String#split の仕様変更を考慮すると
常に正規表現を指定すべきです。

Ruby ...

• Kernel
• spec/rubycmd

CGI::HtmlExtension#html(attributes = {}) -> String (28225.0)

• 2.3.0

• インスタンスメソッド

トップレベルの html 要素を生成します。 ブロックを与えると、ブロックを評価した結果が内容になります。

トップレベルの html 要素を生成します。
ブロックを与えると、ブロックを評価した結果が内容になります。

@param attributes 属性をハッシュで指定します。
擬似属性の "PRETTY" に文字列を与えるとその文字列でインデントした HTML を生成します。
擬似属性の "DOCTYPE" には DOCTYPE 宣言として使用する文字列を与えることができます。

例:

html{ "string" }
# <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2...

• CGI::HtmlExtension

CGI::HtmlExtension#html(attributes = {}) { ... } -> String (28225.0)

• 2.3.0

• インスタンスメソッド

トップレベルの html 要素を生成します。 ブロックを与えると、ブロックを評価した結果が内容になります。

トップレベルの html 要素を生成します。
ブロックを与えると、ブロックを評価した結果が内容になります。

@param attributes 属性をハッシュで指定します。
擬似属性の "PRETTY" に文字列を与えるとその文字列でインデントした HTML を生成します。
擬似属性の "DOCTYPE" には DOCTYPE 宣言として使用する文字列を与えることができます。

例:

html{ "string" }
# <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2...

• CGI::HtmlExtension

IRB::Inspector.def_inspector(key, arg = nil) { |v| ... } -> object (27991.0)

• 2.3.0

• 特異メソッド

新しい実行結果の出力方式を定義します。

新しい実行結果の出力方式を定義します。

@param key conf.inspect_mode や IRB.conf[:INSPECT_MODE] に指定するキー
オブジェクトを指定します。配列を指定した場合は配列中の要素全
てが対象になります。

@param arg ブロックを指定する場合には、inspect_mode の初期化のための手続
きオブジェクトを指定します。あらかじめ require が必要な場合
などに、proc { require "foo" } といった指定を行います。
...

• IRB::Inspector

絞り込み条件を変える

ruby 1.6 feature (26317.0)

• 2.3.0

• 文書

ruby 1.6 feature ruby version 1.6 は安定版です。この版での変更はバグ修正がメイン になります。

ruby 1.6 feature
ruby version 1.6 は安定版です。この版での変更はバグ修正がメイン
になります。

((<stable-snapshot|URL:ftp://ftp.netlab.co.jp/pub/lang/ruby/stable-snapshot.tar.gz>)) は、日々更新される安定版の最新ソースです。

== 1.6.8 (2002-12-24) -> stable-snapshot

: 2003-01-22: errno

EAGAIN と EWOULDBLOCK が同じ値のシステムで、EWOULDBLOCK がなくなっ
ていま...

Kernel#libpathflag(libpath = $DEFLIBPATH|$LIBPATH) -> String (20170.0)

• 2.3.0

• インスタンスメソッド

与えられた libpath を -L 付きの文字列に変換して返します。

与えられた libpath を -L 付きの文字列に変換して返します。

@param libpath LIBPATH に指定する値を指定します。

• Kernel

Kernel.#format(format, *arg) -> String (19603.0)

• 2.3.0

• モジュール関数

format 文字列を C 言語の sprintf と同じように解釈し、 引数をフォーマットした文字列を返します。

format 文字列を C 言語の sprintf と同じように解釈し、
引数をフォーマットした文字列を返します。

@param format フォーマット文字列です。
@param arg フォーマットされる引数です。
@see Kernel.#printf,Time#strftime,Date.strptime

=== sprintf フォーマット

Ruby の sprintf フォーマットは基本的に C 言語の sprintf(3)
のものと同じです。ただし、short や long などの C 特有の型に対する修飾子が
ないこと、2進数の指示子(%b, %B)が存在すること、s...

• Kernel
• String

Kernel.#sprintf(format, *arg) -> String (19603.0)

• 2.3.0

• モジュール関数

format 文字列を C 言語の sprintf と同じように解釈し、 引数をフォーマットした文字列を返します。

format 文字列を C 言語の sprintf と同じように解釈し、
引数をフォーマットした文字列を返します。

@param format フォーマット文字列です。
@param arg フォーマットされる引数です。
@see Kernel.#printf,Time#strftime,Date.strptime

=== sprintf フォーマット

Ruby の sprintf フォーマットは基本的に C 言語の sprintf(3)
のものと同じです。ただし、short や long などの C 特有の型に対する修飾子が
ないこと、2進数の指示子(%b, %B)が存在すること、s...

• Kernel
• String

WEBrick::CGI#start(env = ENV, stdin = $stdin, stdout = $stdout) -> () (19579.0)

• 2.3.0

• インスタンスメソッド

自身に定義されたサービスを実行します。

自身に定義されたサービスを実行します。

start メソッドは service メソッドを呼び出し、service メソッドはリクエストに応じて
do_XXX メソッドを呼び出します。このようにして CGI スクリプトは実行されます。

@param env CGI スクリプトが受け取った Meta-Variables (環境変数)を保持したハッシュか、
それと同じ [] メソッドを持ったオブジェクトを指定します。

@param stdin リクエストデータの入力元を IO オブジェクトで指定します。

@param stdout レスポンスデータの出力先を IO ...

• IO
• WEBrick::CGI

絞り込み条件を変える

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

• 2.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 (19561.0)

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

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

• 2.3.0

• インスタンスメソッド

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

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

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

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


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

# test.r...

• ARGF.class

String#split(sep = $;, limit = 0) -> [String] (19417.0)

• 2.3.0

• インスタンスメソッド

第 1 引数 sep で指定されたセパレータによって文字列を limit 個まで分割し、 結果を文字列の配列で返します。

第 1 引数 sep で指定されたセパレータによって文字列を limit 個まで分割し、
結果を文字列の配列で返します。

第 1 引数 sep は以下のいずれかです。

: 正規表現
正規表現にマッチする部分で分割する。
特に、括弧によるグルーピングがあればそのグループにマッチした
文字列も結果の配列に含まれる (後述)。
: 文字列
その文字列自体にマッチする部分で分割する。
: 1 バイトの空白文字 ' '
先頭と末尾の空白を除いたうえで、空白文字列で分割する。
: nil
常に $; で分割する。 $; も nil の場合は、先頭と末尾...

• String

Kernel.#trace_var(varname, hook) -> [String|Proc] (19399.0)

• 2.3.0

• モジュール関数

グローバル変数 varname への代入のフックを登録します。

グローバル変数 varname への代入のフックを登録します。

ここでの「グローバル変数」は、特殊変数
(d:spec/variables#builtin を参照)も含めた `$' で始まる変数のこ
とです。

この呼び出し以降、varname で指定したグローバル変数に
値が代入されるたびに hook かブロックが評価されます。hook が Proc オブジェクトの場合
代入された値がブロック引数に渡されます。文字列の場合はRubyコードとして評価されます。

trace_var がフックするのは明示的な代入だけです。
フックは複数登録できます。

フックを解除するには、hook に n...

• Kernel
• Proc
• Symbol

絞り込み条件を変える

Kernel.#require_relative(relative_feature) -> bool (19363.0)

• 2.3.0

• モジュール関数

現在のファイルからの相対パスで require します。

現在のファイルからの相対パスで require します。

require File.expand_path(relative_feature, File.dirname(__FILE__))
とほぼ同じです。

Kernel.#eval などで文字列を評価した場合に、そこから
require_relative を呼出すと必ず失敗します。

@param relative_feature ファイル名の文字列です。
@raise LoadError ロードに失敗した場合に発生します。
@see Kernel.#require

=== require と load のスコープ

ローカル変数...

• Kernel

Kernel.#untrace_var(varname, hook = nil) -> [String|Proc] (19327.0)

• 2.3.0

• モジュール関数

グローバル変数 varname に関連付けられたフックを解除します。

グローバル変数 varname に関連付けられたフックを解除します。

hook が指定された場合にはそのフックだけを解除します。
省略するか nil を与えた場合は
varname のフックを全て解除します。

@param varname グローバル変数名を文字列か Symbol で指定します。
@param hook 文字列または Proc オブジェクトです。
@return 解除されたフックの配列を返します。

//emlist[例][ruby]{
trace_var(:$v){|val| print "hookA.#{val.inspect},\n" }
block = proc{...

• Kernel
• Proc
• Symbol

Zlib::GzipReader#gets(rs = $/) -> String | nil (19309.0)

• 2.3.0

• インスタンスメソッド

IO クラスの同名メソッドIO#getsと同じです。

IO クラスの同名メソッドIO#getsと同じです。

但し、gzip ファイル中に
エラーがあった場合 Zlib::Error 例外や
Zlib::GzipFile::Error 例外が発生します。

gzip ファイルのフッターの処理に注意して下さい。
gzip ファイルのフッターには圧縮前データのチェックサムが
記録されています。GzipReader オブジェクトは、次の時に展開した
データとフッターの照合を行い、エラーがあった場合は
Zlib::GzipFile::NoFooter, Zlib::GzipFile::CRCError,
Zlib::GzipFile::LengthErr...

• Zlib::Error
• Zlib::GzipFile::CRCError
• Zlib::GzipFile::Error
• Zlib::GzipFile::LengthError
• Zlib::GzipFile::NoFooter
• Zlib::GzipReader

REXML::Document#write(output = $stdout, indent = -1, transitive = false, ie_hack = false, encoding=nil) -> () (19303.0)

• 2.3.0

• インスタンスメソッド

output に XML 文書を出力します。

output に XML 文書を出力します。

XML宣言、DTD、処理命令を(もしあるならば)含む文書を出力します。

注意すべき点として、
元の XML 文書が XML宣言を含んでいなくとも
出力される XML はデフォルトの XML 宣言を含んでいるべきであるが、
REXML は明示しない限り(つまりXML宣言を REXML::Document#add で
追加しない限り)
それをしない、ということである。XML-RPCのような利用法では
ネットワークバンドを少しでも節約する必要があるためである。

2.0.0以降ではキーワード引数による引数指定が可能です。

@param outpu...

• IO
• REXML::Document

REXML::Document#write(output: $stdout, indent: -1, transitive: false, ie_hack: false, encoding: nil) -> () (19303.0)

• 2.3.0

• インスタンスメソッド

output に XML 文書を出力します。

output に XML 文書を出力します。

XML宣言、DTD、処理命令を(もしあるならば)含む文書を出力します。

注意すべき点として、
元の XML 文書が XML宣言を含んでいなくとも
出力される XML はデフォルトの XML 宣言を含んでいるべきであるが、
REXML は明示しない限り(つまりXML宣言を REXML::Document#add で
追加しない限り)
それをしない、ということである。XML-RPCのような利用法では
ネットワークバンドを少しでも節約する必要があるためである。

2.0.0以降ではキーワード引数による引数指定が可能です。

@param outpu...

• IO
• REXML::Document

絞り込み条件を変える

ARGF.class#readbyte -> Integer (19273.0)

• 2.3.0

• インスタンスメソッド

自身から 1 バイトを読み込み整数として返します。 既に EOF に達していれば EOFError が発生します。

自身から 1 バイトを読み込み整数として返します。
既に EOF に達していれば EOFError が発生します。

@raise EOFError 既に EOF に達している場合に発生します。

$ echo "foo" > file
$ ruby argf.rb file

ARGF.readbyte # => 102
ARGF.readbyte # => 111
ARGF.readbyte # => 111
ARGF.readbyte # => 10
ARGF.readbyte # => end of file reached (EOFError)...

• ARGF.class

IO#gets(rs = $/) -> String | nil (19273.0)

• 2.3.0

• インスタンスメソッド

一行読み込んで、読み込みに成功した時にはその文字列を返します。 EOF に到達した時には nil を返します。

一行読み込んで、読み込みに成功した時にはその文字列を返します。
EOF に到達した時には nil を返します。

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

読み込んだ文字列を変数 $_ にセットします。
IO#readline との違いは EOF での振る舞いのみです。

limit で最大の読み込みバイト数を指定します。ただし
ファイルのエンコーディングがマルチバイトエンコーディングである場合には
読み込んだ文字列がマルチバイト文字の途中で切れないように
数バイト余分に読み込む場合があります。

@param rs 行の区切りを文字列で指定します。rs に nil を指定すると行区切り...

• IO

Kernel.#gets(rs = $/) -> String | nil (19273.0)

• 2.3.0

• モジュール関数

ARGFから一行読み込んで、それを返します。 行の区切りは引数 rs で指定した文字列になります。

ARGFから一行読み込んで、それを返します。
行の区切りは引数 rs で指定した文字列になります。

rs に nil を指定すると行区切りなしとみなしてファイルの内容を
すべて読み込みます。ARGVに複数のファイル名が存在する場合は1度に1ファイルずつ読み込みます。
空文字列 "" を指定すると連続する改行を行の区切りとみなします
(パラグラフモード)。

読み込んだ文字列は組み込み変数 $_ にもセットされます。

@param rs 行の区切りとなる文字列です。
@return ファイルの終り(EOF)に到達した時、 nil を返します。
@raise Errno::EXXX 読み込み...

• ARGF
• Kernel

Encoding::Converter#convert(source_string) -> String (19261.0)

• 2.3.0

• インスタンスメソッド

与えられた文字列を変換して、変換できた結果を返します。 引数の末尾の文字がバイト列の途中で終わっている場合、そのバイト列は変換器内に取り置かれます。 変換を終了させるには Encoding::Converter#finish を呼びます。

与えられた文字列を変換して、変換できた結果を返します。
引数の末尾の文字がバイト列の途中で終わっている場合、そのバイト列は変換器内に取り置かれます。
変換を終了させるには Encoding::Converter#finish を呼びます。

Encoding::Converter を用いると、文字列の一部または全部を渡して変換を行うことができます。よって、不正なバイトを意識せずにストリームから読み出した文字列を変換したいときには Encoding::Converter が適します。

なお、Encoding::Converter#convert では、これらの例外を捕獲しても、例外を起こしたと...

• Encoding::Converter

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

• 2.3.0

• 特異メソッド

GC::Profiler.result の結果を out に出力します。

GC::Profiler.result の結果を out に出力します。

@param out 結果の出力先を指定します。デフォルトは $stdout です。

//emlist[例][ruby]{
GC::Profiler.enable
GC.start
GC::Profiler.report

# => GC 4 invokes.
# Index Invoke Time(sec) Use Size(byte) Total Size(byte) Total Object GC Time(ms)
# 1...

• GC::Profiler

絞り込み条件を変える

StringIO#gets(rs = $/) -> String | nil (19255.0)

• 2.3.0

• インスタンスメソッド

自身から 1 行読み込んで、その文字列を返します。文字列の終端に到達した時には nil を返します。 $_ に読み込んだ行がセットされます。

自身から 1 行読み込んで、その文字列を返します。文字列の終端に到達した時には nil を返します。
$_ に読み込んだ行がセットされます。

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

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

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("hoge")
a.gets ...

• StringIO

Kernel$$_ -> String | nil (19237.0)

• 2.3.0

• 変数

最後に Kernel.#gets または Kernel.#readline で読み込んだ文字列です。 EOF に達した場合には、 nil になります。 (覚え方: Perlと同じ)

最後に Kernel.#gets または Kernel.#readline で読み込んだ文字列です。
EOF に達した場合には、 nil になります。
(覚え方: Perlと同じ)

Kernel.#print のような Perl 由来の幾つかのメソッドは、引数を省略すると代わりに $_ を利用します。

この変数はローカルスコープかつスレッドローカルです。
Ruby起動時の初期値は nil です。

@see Kernel.#print, Kernel.#gets, Kernel.#readline, Object::ARGF

=== 例
example.txt:
foo
bar
...

• Kernel

OpenSSL::Buffering#gets(eol=$/, limit=nil) -> String | nil (19237.0)

• 2.3.0

• インスタンスメソッド

通信路から一行読み込んで、それを返します。

通信路から一行読み込んで、それを返します。

行区切りは eol で指定した文字列/正規表現になります。

最大 limit バイトの文字列を返します。1 行がそれより
長い場合はそこで切られます。limit が nil の場合は
eol に到達するまで読み込みます。

読み込みが終端に到達した場合は nil を返します。

IO#gets と同様ですが、区切り文字列に
"" を渡した場合や、nil を渡したときの意味が異なり、
これらの場合は正しく動作しません。

@param eol 行区切り文字列/正規表現
@param limit 最大の読み込みバイト数

• OpenSSL::Buffering

Encoding::Converter#insert_output(string) -> nil (19225.0)

• 2.3.0

• インスタンスメソッド

変換器内のバッファに文字列を挿入します。 バッファに保持された文字列は、次の変換時の変換結果と一緒に返されます。

変換器内のバッファに文字列を挿入します。
バッファに保持された文字列は、次の変換時の変換結果と一緒に返されます。

変換先がステートフルなエンコーディングであった場合、
挿入された文字列は状態に基づいて変換され、状態を更新します。

このメソッドは変換に際してエラーが発生した際にのみ利用されるべきです。

@param string 挿入する文字列

//emlist[][ruby]{
ec = Encoding::Converter.new("utf-8", "iso-8859-1")
src = "HIRAGANA LETTER A is \u{3042}."
dst = ""
p ec....

• Encoding::Converter

Kernel$$? -> Process::Status | nil (19219.0)

• 2.3.0

• 変数

このスレッドで最後に終了した子プロセスのステータスです。

このスレッドで最後に終了した子プロセスのステータスです。

Process::Status オブジェクトが入っています。
子プロセスの終了時ステータスは Process::Status#exitstatus で得られます。

この変数はスレッドローカルで読み取り専用です。

@see Process.#wait

• Kernel
• Process::Status

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

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

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


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

# test.r...

• ARGF.class

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

• 2.3.0

• インスタンスメソッド

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

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

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

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


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

# test.r...

• ARGF.class

Kernel.#printf(format, *arg) -> nil (19171.0)

• 2.3.0

• モジュール関数

C 言語の printf と同じように、format に従い引数を文字列に変 換して port に出力します。

C 言語の printf と同じように、format に従い引数を文字列に変
換して port に出力します。

port を省略した場合は標準出力 $stdout に出力します。

引数を 1 つも指定しなければ何もしません。

Ruby における format 文字列の拡張については
Kernel.#sprintfの項を参照してください。

@param port 出力先になるIO のサブクラスのインスタンスです。
@param format フォーマット文字列です。
@param arg フォーマットされる引数です。
@raise ArgumentError port を指定したのに ...

• IO
• Kernel

Kernel.#printf(port, format, *arg) -> nil (19171.0)

• 2.3.0

• モジュール関数

C 言語の printf と同じように、format に従い引数を文字列に変 換して port に出力します。

C 言語の printf と同じように、format に従い引数を文字列に変
換して port に出力します。

port を省略した場合は標準出力 $stdout に出力します。

引数を 1 つも指定しなければ何もしません。

Ruby における format 文字列の拡張については
Kernel.#sprintfの項を参照してください。

@param port 出力先になるIO のサブクラスのインスタンスです。
@param format フォーマット文字列です。
@param arg フォーマットされる引数です。
@raise ArgumentError port を指定したのに ...

• IO
• Kernel

OptionParser::Arguable#getopts(short_opt, *long_opt) -> Hash (19117.0)

• 2.3.0

• インスタンスメソッド

指定された short_opt や long_opt に応じて自身をパースし、結果を Hash として返します。

指定された short_opt や long_opt に応じて自身をパースし、結果を Hash として返します。

コマンドラインに - もしくは -- を指定した場合、それ以降の解析を行ないません。

@param short_opt ショートネームのオプション(-f や -fx)を文字列で指定します。オプションが -f と -x の
2つの場合は "fx" の様に指定します。ここでオプションがないときは空文字列を指定します。
オプションが引数をとる場合は直後に ":" を付けます。

@param long_opt ロン...

• OptionParser::Arguable

絞り込み条件を変える

Kernel.#trace_var(varname) {|new_val| .... } -> nil (19099.0)

• 2.3.0

• モジュール関数

グローバル変数 varname への代入のフックを登録します。

グローバル変数 varname への代入のフックを登録します。

ここでの「グローバル変数」は、特殊変数
(d:spec/variables#builtin を参照)も含めた `$' で始まる変数のこ
とです。

この呼び出し以降、varname で指定したグローバル変数に
値が代入されるたびに hook かブロックが評価されます。hook が Proc オブジェクトの場合
代入された値がブロック引数に渡されます。文字列の場合はRubyコードとして評価されます。

trace_var がフックするのは明示的な代入だけです。
フックは複数登録できます。

フックを解除するには、hook に n...

• Kernel
• Proc
• Symbol

Kernel.#trace_var(varname, hook) -> nil (19099.0)

• 2.3.0

• モジュール関数

グローバル変数 varname への代入のフックを登録します。

グローバル変数 varname への代入のフックを登録します。

ここでの「グローバル変数」は、特殊変数
(d:spec/variables#builtin を参照)も含めた `$' で始まる変数のこ
とです。

この呼び出し以降、varname で指定したグローバル変数に
値が代入されるたびに hook かブロックが評価されます。hook が Proc オブジェクトの場合
代入された値がブロック引数に渡されます。文字列の場合はRubyコードとして評価されます。

trace_var がフックするのは明示的な代入だけです。
フックは複数登録できます。

フックを解除するには、hook に n...

• Kernel
• Proc
• Symbol

ARGF.class#internal_encoding -> Encoding | nil (19063.0)

• 2.3.0

• インスタンスメソッド

ARGF から読み込んだ文字列の内部エンコーディングを返します。 内部エンコーディングが指定されていない場合は nil を返します。

ARGF から読み込んだ文字列の内部エンコーディングを返します。
内部エンコーディングが指定されていない場合は nil を返します。

まだ読み込み処理を始めていない場合は Encoding.default_external を返します。

ARGF.class#set_encoding で設定します。


例:
# $ ruby -Eutf-8 test.rb

# test.rb
ARGF.internal_encoding # => #<Encoding:UTF-8>
ARGF.set_encoding('utf-8','ascii')
ARG...

• ARGF.class
• IO

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

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

• Module
• Object

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

• 2.3.0

• モジュール関数

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

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

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


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

コマンドを実行することができなかった場合、多くのシェルはステータス
127 を返します。シェルを介さない場合は Ruby の子プロセスがステータス
127 で終了します。コマンドが実行できなかったのか、コマンドが失敗したの
かは、普通 $? を参照することで判別可能です。

Hash...

• Kernel

絞り込み条件を変える

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

• 2.3.0

• モジュール関数

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

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

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


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

コマンドを実行することができなかった場合、多くのシェルはステータス
127 を返します。シェルを介さない場合は Ruby の子プロセスがステータス
127 で終了します。コマンドが実行できなかったのか、コマンドが失敗したの
かは、普通 $? を参照することで判別可能です。

Hash...

• Kernel

Kernel#try_static_assert(expr, headers = nil, opt = "") -> bool (19021.0)

• 2.3.0

• インスタンスメソッド

@todo ???

@todo ???

...

@param expr C 言語の式を指定します。

@param headers 追加のヘッダファイルを指定します。

@param opt コンパイラに渡すオプションを指定します。
$CFLAGS もコンパイラには渡されます。

• Kernel

Kernel#try_static_assert(expr, headers = nil, opt = "") { ... } -> bool (19021.0)

• 2.3.0

• インスタンスメソッド

@todo ???

@todo ???

...

@param expr C 言語の式を指定します。

@param headers 追加のヘッダファイルを指定します。

@param opt コンパイラに渡すオプションを指定します。
$CFLAGS もコンパイラには渡されます。

• Kernel

ARGF.class#getbyte -> Integer | nil (19009.0)

• 2.3.0

• インスタンスメソッド

self から 1 バイト(0..255)を読み込み整数として返します。 既に EOF に達していれば nil を返します。

self から 1 バイト(0..255)を読み込み整数として返します。
既に EOF に達していれば nil を返します。

ARGF はスクリプトに指定した引数(Object::ARGV を参照) をファイル名
とみなして、それらのファイルを連結した 1 つの仮想ファイルを表すオブジェ
クトです。そのため、最初のファイルを最後まで読んだ後は次のファイルの内
容を返します。

$ echo "foo" > file1
$ echo "bar" > file2
$ ruby argf.rb file1 file2

ARGF.getbyte # => 102
ARGF.g...

• ARGF.class

ARGF.class#getc -> String | nil (19009.0)

• 2.3.0

• インスタンスメソッド

self から 1 文字読み込んで返します。EOF に到達した時には nil を返します。

self から 1 文字読み込んで返します。EOF に到達した時には nil を返します。

ARGF はスクリプトに指定した引数(Object::ARGV を参照) をファイル名
とみなして、それらのファイルを連結した 1 つの仮想ファイルを表すオブジェ
クトです。そのため、最初のファイルを最後まで読んだ後は次のファイルの内
容を返します。

$ echo "foo" > file1
$ echo "bar" > file2
$ ruby argf.rb file1 file2

ARGF.getc # => "f"
ARGF.getc # => "o"
ARGF....

• ARGF.class

絞り込み条件を変える

Enumerable#sort_by -> Enumerator (19009.0)

• 2.3.0

• インスタンスメソッド

ブロックの評価結果を <=> メソッドで比較することで、self を昇 順にソートします。ソートされた配列を新たに生成して返します。

ブロックの評価結果を <=> メソッドで比較することで、self を昇
順にソートします。ソートされた配列を新たに生成して返します。

つまり、以下とほぼ同じ動作をします。

//emlist[例][ruby]{
class Array
def sort_by
self.map {|i| [yield(i), i] }.
sort {|a, b| a[0] <=> b[0] }.
map {|i| i[1]}
end
end
//}

Enumerable#sort と比較して sort_by が優れている点として、
比較条件が複雑な場合の速度が挙...

• Enumerable
• Enumerator

Enumerable#sort_by {|item| ... } -> [object] (19009.0)

• 2.3.0

• インスタンスメソッド

ブロックの評価結果を <=> メソッドで比較することで、self を昇 順にソートします。ソートされた配列を新たに生成して返します。

ブロックの評価結果を <=> メソッドで比較することで、self を昇
順にソートします。ソートされた配列を新たに生成して返します。

つまり、以下とほぼ同じ動作をします。

//emlist[例][ruby]{
class Array
def sort_by
self.map {|i| [yield(i), i] }.
sort {|a, b| a[0] <=> b[0] }.
map {|i| i[1]}
end
end
//}

Enumerable#sort と比較して sort_by が優れている点として、
比較条件が複雑な場合の速度が挙...

• Enumerable
• Enumerator

IO#putc(ch) -> object (19009.0)

• 2.3.0

• インスタンスメソッド

文字 ch を self に出力します。 引数の扱いは Kernel.#putc と同じです。詳細はこちらを参照し てください。ch を返します。

文字 ch を self に出力します。
引数の扱いは Kernel.#putc と同じです。詳細はこちらを参照し
てください。ch を返します。

@param ch 出力したい文字を、文字列か文字コード(整数)で与えます。

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

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

//emlist[例][ruby]{
$stdout.putc "A" # => A
$stdout.putc 65 # => A
//}

@see Kernel.#putc

• IO

Kernel#with_config(config, default = nil) -> bool | String (19009.0)

• 2.3.0

• インスタンスメソッド

configure のオプションを検査します。

configure のオプションを検査します。

configure のオプションに --with-<config> が指定された場合は真を返しま
す。--without-<config> が指定された場合は偽を返します。どちらでもない場
合は default を返します。

これはデバッグ情報などのカスタム定義を、追加するのに役立ちます。

@param config configure のオプションの名前を指定します。

@param default デフォルト値を返します。

例
require 'mkmf'
if with_config("debug")
$defs...

• Kernel

Kernel#with_config(config, default = nil) {|config, default| ... } -> bool | String (19009.0)

• 2.3.0

• インスタンスメソッド

configure のオプションを検査します。

configure のオプションを検査します。

configure のオプションに --with-<config> が指定された場合は真を返しま
す。--without-<config> が指定された場合は偽を返します。どちらでもない場
合は default を返します。

これはデバッグ情報などのカスタム定義を、追加するのに役立ちます。

@param config configure のオプションの名前を指定します。

@param default デフォルト値を返します。

例
require 'mkmf'
if with_config("debug")
$defs...

• Kernel

絞り込み条件を変える

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

• 2.3.0

• モジュール関数

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

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

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


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

コマンドを実行することができなかった場合、多くのシェルはステータス
127 を返します。シェルを介さない場合は Ruby の子プロセスがステータス
127 で終了します。
コマンドが実行できなかったのか、コマンドが失敗したのかは、普通
$? を参照することで判別可能です。

=== ...

• Kernel

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

• 2.3.0

• モジュール関数

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

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

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


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

コマンドを実行することができなかった場合、多くのシェルはステータス
127 を返します。シェルを介さない場合は Ruby の子プロセスがステータス
127 で終了します。
コマンドが実行できなかったのか、コマンドが失敗したのかは、普通
$? を参照することで判別可能です。

=== ...

• Kernel

OptionParser#permute(*args) -> [String] (19009.0)

• 2.3.0

• インスタンスメソッド

与えられた argv をパースします。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv からオプションを取り除いたものを返します。

与えられた argv をパースします。
オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。
argv からオプションを取り除いたものを返します。

下の例で言うと、order と違いコマンドの引数 somefile よりも後ろにオプションを置くことが
できます。

@param argv パースしたい引数を文字列の配列で指定します。

@param args パースしたい引数を順に文字列として与えます。


@raise OptionParser::ParseError パースに失敗した場合、発生します。
...

• OptionParser

OptionParser#permute(argv) -> [String] (19009.0)

• 2.3.0

• インスタンスメソッド

与えられた argv をパースします。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv からオプションを取り除いたものを返します。

与えられた argv をパースします。
オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。
argv からオプションを取り除いたものを返します。

下の例で言うと、order と違いコマンドの引数 somefile よりも後ろにオプションを置くことが
できます。

@param argv パースしたい引数を文字列の配列で指定します。

@param args パースしたい引数を順に文字列として与えます。


@raise OptionParser::ParseError パースに失敗した場合、発生します。
...

• OptionParser

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

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

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

@see Kernel.#print

• IO

絞り込み条件を変える

IO#puts(*obj) -> nil (18991.0)

• 2.3.0

• インスタンスメソッド

各 obj を self に出力し、それぞれの後に改行を出力します。 引数の扱いは Kernel.#puts と同じです。詳細はこちらを参照し てください。

各 obj を self に出力し、それぞれの後に改行を出力します。
引数の扱いは Kernel.#puts と同じです。詳細はこちらを参照し
てください。

@param obj 出力したいオブジェクトを指定します。Kernel.#puts と同じです。

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

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

$stdout.puts("this", "is", "a", "test", [1, [nil, 3]])

#=>
thi...

• IO

Kernel#try_constant(const, headers = nil, opt = "") -> Integer | nil (18991.0)

• 2.3.0

• インスタンスメソッド

定数 const がシステムに存在するかどうか検査します。 Kernel#have_const を使ってください。

定数 const がシステムに存在するかどうか検査します。
Kernel#have_const を使ってください。

@param const C 言語の定数名を指定します。

@param headers 追加のヘッダファイルを指定します。

@param opt コンパイラに渡すオプションを指定します。
$CFLAGS もコンパイラには渡されます。

@return 定数 const がシステムに存在する場合はその値を返します。
定数 const がシステムに存在しない場合は nil を返します。

• Kernel

Kernel#try_constant(const, headers = nil, opt = "") { ... } -> Integer | nil (18991.0)

• 2.3.0

• インスタンスメソッド

定数 const がシステムに存在するかどうか検査します。 Kernel#have_const を使ってください。

定数 const がシステムに存在するかどうか検査します。
Kernel#have_const を使ってください。

@param const C 言語の定数名を指定します。

@param headers 追加のヘッダファイルを指定します。

@param opt コンパイラに渡すオプションを指定します。
$CFLAGS もコンパイラには渡されます。

@return 定数 const がシステムに存在する場合はその値を返します。
定数 const がシステムに存在しない場合は nil を返します。

• Kernel

Kernel#try_run(src, opt = "") -> bool | nil (18991.0)

• 2.3.0

• インスタンスメソッド

与えられたソースコードが、コンパイルやリンクできるかどうか検査します。

与えられたソースコードが、コンパイルやリンクできるかどうか検査します。

以下の全ての検査に成功した場合は、真を返します。そうでない場合は偽を返します。

* src が C のソースとしてコンパイルできるか
* 生成されたオブジェクトが依存しているライブラリとリンクできるか
* リンクしたファイルが実行可能かどうか
* 実行ファイルがきちんと存在しているかどうか

ブロックを与えた場合、そのブロックはコンパイル前に評価されます。
ブロック内でソースコードを変更することができます。

@param src C のソースコードを指定します。

@param opt リンカに渡す...

• Kernel

Kernel#try_run(src, opt = "") { ... } -> bool | nil (18991.0)

• 2.3.0

• インスタンスメソッド

与えられたソースコードが、コンパイルやリンクできるかどうか検査します。

与えられたソースコードが、コンパイルやリンクできるかどうか検査します。

以下の全ての検査に成功した場合は、真を返します。そうでない場合は偽を返します。

* src が C のソースとしてコンパイルできるか
* 生成されたオブジェクトが依存しているライブラリとリンクできるか
* リンクしたファイルが実行可能かどうか
* 実行ファイルがきちんと存在しているかどうか

ブロックを与えた場合、そのブロックはコンパイル前に評価されます。
ブロック内でソースコードを変更することができます。

@param src C のソースコードを指定します。

@param opt リンカに渡す...

• Kernel

絞り込み条件を変える

OptionParser#permute!(argv = self.default_argv) -> [String] (18991.0)

• 2.3.0

• インスタンスメソッド

与えられた argv を破壊的にパースします。argv からオプションがすべて取り除かれます。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv を返します。

与えられた argv を破壊的にパースします。argv からオプションがすべて取り除かれます。
オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。
argv を返します。

下の例で言うと、order と違いコマンドの引数 somefile よりも後ろにオプションを置くことが
できます。

@param argv パースしたい引数を文字列の配列で指定します。


@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は Optio...

• OptionParser

Kernel#try_cpp(src, opt = "", *opts) -> bool (18973.0)

• 2.3.0

• インスタンスメソッド

C プログラムのソースコード src をプリプロセスします。

C プログラムのソースコード src をプリプロセスします。

$CPPFLAGS, $CFLAGS の値もプリプロセッサにコマンドライン引数
として渡します。

このメソッドはヘッダファイルの存在チェックなどに使用します。

@param src C プログラムのソースコードを指定します。

@param opt プリプロセッサにコマンドライン引数として渡す値を指定します。

@return 問題なくプリプロセスできたら true を返します。
プリプロセスに失敗したら false を返します。

例：

require 'mkmf'
if try_cpp("#in...

• Kernel

Kernel#try_cpp(src, opt = "", *opts) { ... } -> bool (18973.0)

• 2.3.0

• インスタンスメソッド

C プログラムのソースコード src をプリプロセスします。

C プログラムのソースコード src をプリプロセスします。

$CPPFLAGS, $CFLAGS の値もプリプロセッサにコマンドライン引数
として渡します。

このメソッドはヘッダファイルの存在チェックなどに使用します。

@param src C プログラムのソースコードを指定します。

@param opt プリプロセッサにコマンドライン引数として渡す値を指定します。

@return 問題なくプリプロセスできたら true を返します。
プリプロセスに失敗したら false を返します。

例：

require 'mkmf'
if try_cpp("#in...

• Kernel

Gem::Command#add_extra_args(args) -> Array (18967.0)

• 2.3.0

• インスタンスメソッド

$HOME/.gemrc から読み込んだ引数を追加します。

$HOME/.gemrc から読み込んだ引数を追加します。

@param args 追加する引数を配列で指定します。

• Gem::Command

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

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

絞り込み条件を変える

Kernel#try_compile(src, opt = "", *opts) -> bool (18955.0)

• 2.3.0

• インスタンスメソッド

与えられた C のソースコードがコンパイルできた場合は真を返します。 コンパイルできなかった場合は偽を返します。

与えられた C のソースコードがコンパイルできた場合は真を返します。
コンパイルできなかった場合は偽を返します。

ブロックを与えた場合、そのブロックはコンパイル前に評価されます。
ブロック内でソースコードを変更することができます。

@param src C のソースコードを指定します。

@param opt コンパイラに渡すオプションを指定します。
$CFLAGS もコンパイラには渡されます。

• Kernel

Kernel#try_compile(src, opt = "", *opts) { ... } -> bool (18955.0)

• 2.3.0

• インスタンスメソッド

与えられた C のソースコードがコンパイルできた場合は真を返します。 コンパイルできなかった場合は偽を返します。

与えられた C のソースコードがコンパイルできた場合は真を返します。
コンパイルできなかった場合は偽を返します。

ブロックを与えた場合、そのブロックはコンパイル前に評価されます。
ブロック内でソースコードを変更することができます。

@param src C のソースコードを指定します。

@param opt コンパイラに渡すオプションを指定します。
$CFLAGS もコンパイラには渡されます。

• Kernel

Kernel#try_link(src, opt = "", *options) -> bool (18955.0)

• 2.3.0

• インスタンスメソッド

C プログラムのソースコード src をコンパイル、リンクします。

C プログラムのソースコード src をコンパイル、リンクします。

このメソッドは $CFLAGS と $LDFLAGS の値もコンパイラまたはリ
ンカに渡します。

問題なくリンクできたら true を返します。
コンパイルとリンクに失敗したら false を返します。

@param src C プログラムのソースコードを指定します。

@param opt リンカにコマンド引数として渡す値を指定します。

例：

require 'mkmf'
if try_link("int main() { sin(0.0); }", '-lm')
$stderr.puts "si...

• Kernel

Kernel#try_link(src, opt = "", *options) { ... } -> bool (18955.0)

• 2.3.0

• インスタンスメソッド

C プログラムのソースコード src をコンパイル、リンクします。

C プログラムのソースコード src をコンパイル、リンクします。

このメソッドは $CFLAGS と $LDFLAGS の値もコンパイラまたはリ
ンカに渡します。

問題なくリンクできたら true を返します。
コンパイルとリンクに失敗したら false を返します。

@param src C プログラムのソースコードを指定します。

@param opt リンカにコマンド引数として渡す値を指定します。

例：

require 'mkmf'
if try_link("int main() { sin(0.0); }", '-lm')
$stderr.puts "si...

• Kernel

Object#taint -> self (18955.0)

• 2.3.0

• インスタンスメソッド

このメソッドは Ruby 2.7 から deprecated で、Ruby 3.2 で削除予定です。

このメソッドは Ruby 2.7 から deprecated で、Ruby 3.2 で削除予定です。

オブジェクトの「汚染マーク」をセットします。

環境変数（ENVで得られる文字列）など一部のオブジェクトは最初から汚染されています。
オブジェクトの汚染に関してはspec/safelevelを参照してください。

//emlist[][ruby]{
$SAFE = 1

some = "puts '@&%&(#!'"
p some.tainted? #=> false
eval(some) #=> @&%&(#!

some.taint
p some.tainted? #=> true
e...

• ENV
• Object
• spec/safelevel

絞り込み条件を変える

Net::POP3#set_debug_output(f) -> () (18937.0)

• 2.3.0

• インスタンスメソッド

デバッグ用の出力 f をセットします。

デバッグ用の出力 f をセットします。

このメソッドは深刻なセキュリティホールの原因となりえます。
デバッグ以外の用途では使わないでください。

f は << メソッドを持っているオブジェクトでなければなりません。

使用例:

require 'net/pop'

pop = Net::POP3.new('pop.example.com', 110)
pop.set_debug_output $stderr
pop.start('YourAccount', 'YourPassword') {
p pop.n_bytes
}

実行結果:

POP sessi...

• Net::POP3

ruby 1.8.4 feature (16075.0)

• 2.3.0

• 文書

ruby 1.8.4 feature ruby 1.8.4 での ruby 1.8.3 からの変更点です。

ruby 1.8.4 feature
ruby 1.8.4 での ruby 1.8.3 からの変更点です。

掲載方針

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

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

記号について(特に重要なものは大文字(主観))

# * カテゴリ
# * [ruby]: ruby インタプリタの変更
# * [api]: 拡張ライブラリ API
# * [lib]: ライブラリ
* レベル
* [bug]: バグ修正
* [new]: 追加され...

ruby 1.8.3 feature (14329.0)

• 2.3.0

• 文書

ruby 1.8.3 feature *((<ruby 1.8 feature>)) *((<ruby 1.8.2 feature>))

ruby 1.8.3 feature
*((<ruby 1.8 feature>))
*((<ruby 1.8.2 feature>))

ruby 1.8.2 から ruby 1.8.3 までの変更点です。

掲載方針

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

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

記号について(特に重要なものは大文字(主観))

* カテゴリ
* [ruby]: ruby インタプリタの変更
* [api]: 拡張ライブラリ API
* [lib]: ...

String#%(args) -> String (10585.0)

• 2.3.0

• インスタンスメソッド

printf と同じ規則に従って args をフォーマットします。

printf と同じ規則に従って args をフォーマットします。

args が配列であれば Kernel.#sprintf(self, *args) と同じです。
それ以外の場合は Kernel.#sprintf(self, args) と同じです。

@param args フォーマットする値、もしくはその配列
@return フォーマットされた文字列

//emlist[例][ruby]{
p "i = %d" % 10 # => "i = 10"
p "i = %x" % 10 # => "i = a"
p "i = %o" % 10...

• String

Object#display(out = $stdout) -> nil (10294.0)

• 2.3.0

• インスタンスメソッド

オブジェクトを out に出力します。

オブジェクトを out に出力します。

以下のように定義されています。

//emlist[][ruby]{
class Object
def display(out = $stdout)
out.write self
nil
end
end
//}

@param out 出力先のIOオブジェクトです。指定しない場合は標準出力に出力されます。
@return nil を返します。

//emlist[][ruby]{
Object.new.display #=> #<Object:0xbb0210>
//}

@see $stdout

• Object

絞り込み条件を変える

StringIO#each(rs = $/) -> Enumerator (10273.0)

• 2.3.0

• インスタンスメソッド

自身から 1 行ずつ読み込み、それを引数として与えられたブロックを実行します。

自身から 1 行ずつ読み込み、それを引数として与えられたブロックを実行します。

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

@raise IOError 自身が読み取り不可なら発生します。

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("hoge\nfoo\n")
a.each{|l| p l }
#=> "hoge\n"
# "foo\n"
//}

@see $/
...

• StringIO

StringIO#each_line(rs = $/) -> Enumerator (10273.0)

• 2.3.0

• インスタンスメソッド

自身から 1 行ずつ読み込み、それを引数として与えられたブロックを実行します。

自身から 1 行ずつ読み込み、それを引数として与えられたブロックを実行します。

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

@raise IOError 自身が読み取り不可なら発生します。

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("hoge\nfoo\n")
a.each{|l| p l }
#=> "hoge\n"
# "foo\n"
//}

@see $/
...

• StringIO

StringIO#lines(rs = $/) -> Enumerator (10273.0)

• 2.3.0

• インスタンスメソッド

自身から 1 行ずつ読み込み、それを引数として与えられたブロックを実行します。

自身から 1 行ずつ読み込み、それを引数として与えられたブロックを実行します。

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

@raise IOError 自身が読み取り不可なら発生します。

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("hoge\nfoo\n")
a.each{|l| p l }
#=> "hoge\n"
# "foo\n"
//}

@see $/
...

• StringIO

StringIO#readline(rs = $/) -> String (10273.0)

• 2.3.0

• インスタンスメソッド

自身から 1 行読み込んで、その文字列を返します。

自身から 1 行読み込んで、その文字列を返します。

文字列の終端に到達した時には、例外 EOFError を発生させます。
IO#readline と違い読み込んだ文字列を変数 $_ にセットしません。

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

@raise EOFError 文字列の終端に到達した時に発生します。

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

//emlist[例][rub...

• StringIO

ARGF.class#to_a(rs = $/) -> Array (10255.0)

• 2.3.0

• インスタンスメソッド

ARGFの各行を配列に読み込んで返します。rsがnilの場合は要素に各ファイルを すべて読み込んだ配列を返します。

ARGFの各行を配列に読み込んで返します。rsがnilの場合は要素に各ファイルを
すべて読み込んだ配列を返します。

@param rs 行区切り文字

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

lines = ARGF.readlines
lines[0] # => "This is line one\n"

@see $/, Kernel.#readlines, IO#readlines

• ARGF.class

絞り込み条件を変える

StringIO#readlines(rs = $/) -> [String] (10255.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("hoge\nfoo\nbar\n")
a.readlines ...

• StringIO

String#chomp(rs = $/) -> String (10237.0)

• 2.3.0

• インスタンスメソッド

self の末尾から rs で指定する改行コードを取り除いた文字列を生成して返します。 ただし、rs が "\n" ($/ のデフォルト値) のときは、 実行環境によらず "\r", "\r\n", "\n" のすべてを改行コードとみなして取り除きます。

self の末尾から rs で指定する改行コードを取り除いた文字列を生成して返します。
ただし、rs が "\n" ($/ のデフォルト値) のときは、
実行環境によらず "\r", "\r\n", "\n" のすべてを改行コードとみなして取り除きます。

rs に nil を指定した場合、このメソッドは何もしません。

rs に空文字列 ("") を指定した場合は「パラグラフモード」になり、
実行環境によらず末尾の連続する改行コード("\r\n", "\n")をすべて取り除きます。

//emlist[例][ruby]{
p "foo\n".chomp # => "...

• String

String#each_line(rs = $/) -> Enumerator (10237.0)

• 2.3.0

• インスタンスメソッド

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

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

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

@param rs 行末を示す文字列

//emlist[例][ruby]{
"aa\nbb\ncc\n".each_line do |line|
p line
end
# => "aa\n"
...

• String

String#lines(rs = $/) -> [String] (10237.0)

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

String#gsub(pattern, replace) -> String (10210.0)

• 2.3.0

• インスタンスメソッド

文字列中で pattern にマッチする部分全てを 文字列 replace で置き換えた文字列を生成して返します。

文字列中で pattern にマッチする部分全てを
文字列 replace で置き換えた文字列を生成して返します。

置換文字列 replace 中の \& と \0 はマッチした部分文字列に、
\1 ... \9 は n 番目の括弧の内容に置き換えられます。
置換文字列内では \`、\'、\+ も使えます。
これらは $`、$'、$+ に対応します。

@param pattern 置き換える文字列のパターンを表す文字列か正規表現。
文字列を指定した場合は全く同じ文字列にだけマッチする
@param replace pattern で指定した...

• String

絞り込み条件を変える

String#sub(pattern, replace) -> String (10207.0)

• 2.3.0

• インスタンスメソッド

文字列中で pattern にマッチした最初の部分を 文字列 replace で置き換えた文字列を生成して返します。

文字列中で pattern にマッチした最初の部分を
文字列 replace で置き換えた文字列を生成して返します。

置換文字列 replace 中の \& と \0 はマッチした部分文字列に、
\1 ... \9 は n 番目の括弧の内容に置き換えられます。
置換文字列内では \`、\'、\+ も使えます。
これらは $`、$'、$+ に対応します。

@param pattern 置き換える文字列のパターンを表す文字列か正規表現。
文字列を指定した場合は全く同じ文字列にだけマッチする
@param replace pattern で指定し...

• String

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

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

String#gsub(pattern) -> Enumerator (10105.0)

• 2.3.0

• インスタンスメソッド

文字列中で pattern にマッチした部分を順番にブロックに渡し、 その実行結果で置き換えた文字列を生成して返します。 ブロックなしの場合と違い、ブロックの中からは 組み込み変数 $1, $2, $3, ... を問題なく参照できます。

文字列中で pattern にマッチした部分を順番にブロックに渡し、
その実行結果で置き換えた文字列を生成して返します。
ブロックなしの場合と違い、ブロックの中からは
組み込み変数 $1, $2, $3, ... を問題なく参照できます。

@param pattern 置き換える文字列のパターンを表す文字列か正規表現。
文字列を指定した場合は全く同じ文字列にだけマッチする
@return 新しい文字列

//emlist[例][ruby]{
p 'abcabc'.gsub(/[bc]/) {|s| s.upcase } #=> "aBCaBC"
...

• String

String#gsub(pattern) {|matched| .... } -> String (10105.0)

• 2.3.0

• インスタンスメソッド

文字列中で pattern にマッチした部分を順番にブロックに渡し、 その実行結果で置き換えた文字列を生成して返します。 ブロックなしの場合と違い、ブロックの中からは 組み込み変数 $1, $2, $3, ... を問題なく参照できます。

文字列中で pattern にマッチした部分を順番にブロックに渡し、
その実行結果で置き換えた文字列を生成して返します。
ブロックなしの場合と違い、ブロックの中からは
組み込み変数 $1, $2, $3, ... を問題なく参照できます。

@param pattern 置き換える文字列のパターンを表す文字列か正規表現。
文字列を指定した場合は全く同じ文字列にだけマッチする
@return 新しい文字列

//emlist[例][ruby]{
p 'abcabc'.gsub(/[bc]/) {|s| s.upcase } #=> "aBCaBC"
...

• String

Net::POP3.foreach(address, port = nil, account, password, isapop=false) {|mail| .... } -> () (10099.0)

• 2.3.0

• 特異メソッド

POP セッションを開始し、 サーバ上のすべてのメールを取りだし、 個々のメールを引数としてブロックを呼びだします。

POP セッションを開始し、
サーバ上のすべてのメールを取りだし、
個々のメールを引数としてブロックを呼びだします。

個々のメールは Net::POPMail のインスタンスで渡されます。

port に nil を渡すと、適当なポート(通常は110、SSL利用時には 995)を
使います。

以下のコードと同様の処理をします。
require 'net/pop'

Net::POP3.start(address, port, account, password, isapop=false) {|pop|
pop.each_mail do |m|
yield m
...

• Net::POP3
• Net::POPMail

絞り込み条件を変える