検索結果

Kernel.#test(cmd, file) -> bool | Time | Integer | nil (937.0)

• 3.2

• モジュール関数

単体のファイルでファイルテストを行います。

単体のファイルでファイルテストを行います。

@param cmd 以下に示す文字リテラル、文字列、あるいは同じ文字を表す数値
です。文字列の場合はその先頭の文字だけをコマンドとみなします。
@param file テストするファイルのパスを表す文字列か IO オブジェクトを指定します。
@return 下表に特に明記していないものは、真偽値を返します。

以下は cmd として指定できる文字リテラルとその意味です。

: ?r
ファイルを実効 uid で読むことができる
: ?w
ファイルに実効 uid で書くことができる
: ?x
ファイルを...

• Kernel

Syslog.#open!(ident=$0, options=Syslog::LOG_PID|Syslog::LOG_CONS, facility=Syslog::LOG_USER) { |syslog| ... } -> self (658.0)

• 3.2

• モジュール関数

開いていた syslog を最初にクローズする点を除いてSyslog.#open と同じです。

開いていた syslog を最初にクローズする点を除いてSyslog.#open と同じです。

@param ident すべてのログにつく識別子で、どのプログラムから送られ
たログなのかを識別するために使われる文字列を指定します。
指定しない場合はプログラム名が使われます。

@param options Syslog.open や Syslog.log の動作を制御するフラグを指定します。
指定しない場合は、Syslog::LOG_PID|Syslog::LOG_CONSの値が使われ
...

• Syslog

Syslog.#reopen(ident=$0, options=Syslog::LOG_PID|Syslog::LOG_CONS, facility=Syslog::LOG_USER) { |syslog| ... } -> self (658.0)

• 3.2

• モジュール関数

開いていた syslog を最初にクローズする点を除いてSyslog.#open と同じです。

開いていた syslog を最初にクローズする点を除いてSyslog.#open と同じです。

@param ident すべてのログにつく識別子で、どのプログラムから送られ
たログなのかを識別するために使われる文字列を指定します。
指定しない場合はプログラム名が使われます。

@param options Syslog.open や Syslog.log の動作を制御するフラグを指定します。
指定しない場合は、Syslog::LOG_PID|Syslog::LOG_CONSの値が使われ
...

• Syslog

Syslog.#open(ident=$0, options=Syslog::LOG_PID|Syslog::LOG_CONS, facility=Syslog::LOG_USER) { |syslog| ... } -> self (652.0)

• 3.2

• モジュール関数

与えられた引数でsyslogを開きます。以降、他の Syslog モジュール関数が使 用可能となります。

与えられた引数でsyslogを開きます。以降、他の Syslog モジュール関数が使
用可能となります。

ブロック付きで呼ばれた場合は、self を引数としてブロックを実行し、
最後に Syslog.#close を行います。

syslog の詳細については syslog(3) を参照してください。

@param ident すべてのログにつく識別子で、どのプログラムから送られ
たログなのかを識別するために使われる文字列を指定します。
指定しない場合はプログラム名が使われます。

@param options Syslog.open ...

• RuntimeError
• Syslog
• Syslog::Constants

Kernel.#trap(signal) { ... } -> String | Proc | nil (616.0)

• 3.2

• モジュール関数

signal で指定された割り込みにたいするハンドラとして command を登録します。Signal.#trapと同じです。

signal で指定された割り込みにたいするハンドラとして
command を登録します。Signal.#trapと同じです。

Signal.#trapの使用を推奨します。

@param signal Signal.#trap 参照
@param command Signal.#trap 参照


@see Signal.#trap,Signal

• Kernel
• Signal

絞り込み条件を変える

Kernel.#trap(signal, command) -> String | Proc | nil (616.0)

• 3.2

• モジュール関数

signal で指定された割り込みにたいするハンドラとして command を登録します。Signal.#trapと同じです。

signal で指定された割り込みにたいするハンドラとして
command を登録します。Signal.#trapと同じです。

Signal.#trapの使用を推奨します。

@param signal Signal.#trap 参照
@param command Signal.#trap 参照


@see Signal.#trap,Signal

• Kernel
• Signal

Signal.#trap(signal) { ... } -> String | Proc | nil (616.0)

• 3.2

• モジュール関数

指定された割り込み signal に対するハンドラとして command を登録します。 指定したシグナルが捕捉された時には例外が発生せず、代わりに command が実行されます。 ブロックを指定した場合にはブロックをハンドラとして登録します。

指定された割り込み signal に対するハンドラとして
command を登録します。
指定したシグナルが捕捉された時には例外が発生せず、代わりに command が実行されます。
ブロックを指定した場合にはブロックをハンドラとして登録します。

trap は前回の trap で設定したハンドラを返します。
文字列を登録していた場合はそれを、
ブロックを登録していたらそれを Proc オブジェクトに変換して返します。
また何も登録されていないときも nil を返します。
ruby の仕組みの外でシグナルハンドラが登録された場合
(例えば拡張ライブラリが独自に sigaction を呼んだ場...

• Interrupt
• Proc
• Signal
• SignalException
• Symbol
• spec/terminate

Signal.#trap(signal, command) -> String | Proc | nil (616.0)

• 3.2

• モジュール関数

指定された割り込み signal に対するハンドラとして command を登録します。 指定したシグナルが捕捉された時には例外が発生せず、代わりに command が実行されます。 ブロックを指定した場合にはブロックをハンドラとして登録します。

指定された割り込み signal に対するハンドラとして
command を登録します。
指定したシグナルが捕捉された時には例外が発生せず、代わりに command が実行されます。
ブロックを指定した場合にはブロックをハンドラとして登録します。

trap は前回の trap で設定したハンドラを返します。
文字列を登録していた場合はそれを、
ブロックを登録していたらそれを Proc オブジェクトに変換して返します。
また何も登録されていないときも nil を返します。
ruby の仕組みの外でシグナルハンドラが登録された場合
(例えば拡張ライブラリが独自に sigaction を呼んだ場...

• Interrupt
• Proc
• Signal
• SignalException
• Symbol
• spec/terminate

Kernel.#rand(range) -> Integer | Float | nil (613.0)

• 3.2

• モジュール関数

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

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

最初の形式では
max が 0 の場合は 0.0 以上 1.0 未満の実数を、正の整数の場合は 0 以上 max 未満の整数を返します。
それ以外の値を指定した場合は max.to_int の絶対値が指定されたものとして扱います。

二番目の形式では range で指定された範囲の値を返します。
range の始端と終端が共に整数の場合は整数を、少なくとも片方が実数の場合は実数を返します。
range に含まれる数が無い場合は nil を返します。

まだ Kernel.#srand が呼ばれていなければ自動的に呼び出します。

擬似乱数生成器として Random...

• Kernel
• Random
• Range

ObjectSpace.#each_object {|object| ...} -> Integer (418.0)

• 3.2

• モジュール関数

指定された klass と Object#kind_of? の関係にある全ての オブジェクトに対して繰り返します。引数が省略された時には全てのオブ ジェクトに対して繰り返します。 繰り返した数を返します。

指定された klass と Object#kind_of? の関係にある全ての
オブジェクトに対して繰り返します。引数が省略された時には全てのオブ
ジェクトに対して繰り返します。
繰り返した数を返します。

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

次のクラスのオブジェクトについては繰り返しません

* Fixnum
* Symbol
* TrueClass
* FalseClass
* NilClass

とくに、klass に Fixnum や Symbol などのクラスを指定した場合は、
何も繰り返さないことになります。
なお、Sy...

• Enumerator
• FalseClass
• Fixnum
• NilClass
• ObjectSpace
• Symbol
• TrueClass

絞り込み条件を変える

ObjectSpace.#each_object(klass) {|object| ...} -> Integer (418.0)

• 3.2

• モジュール関数

指定された klass と Object#kind_of? の関係にある全ての オブジェクトに対して繰り返します。引数が省略された時には全てのオブ ジェクトに対して繰り返します。 繰り返した数を返します。

指定された klass と Object#kind_of? の関係にある全ての
オブジェクトに対して繰り返します。引数が省略された時には全てのオブ
ジェクトに対して繰り返します。
繰り返した数を返します。

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

次のクラスのオブジェクトについては繰り返しません

* Fixnum
* Symbol
* TrueClass
* FalseClass
* NilClass

とくに、klass に Fixnum や Symbol などのクラスを指定した場合は、
何も繰り返さないことになります。
なお、Sy...

• Enumerator
• FalseClass
• Fixnum
• NilClass
• ObjectSpace
• Symbol
• TrueClass

Benchmark.#bm(label_width = 0, *labels) {|rep| ... } -> [Benchmark::Tms] (415.0)

• 3.2

• モジュール関数

Benchmark.#benchmark メソッドの引数を簡略化したものです。

Benchmark.#benchmark メソッドの引数を簡略化したものです。

Benchmark.#benchmark メソッドと同様に働きます。

@param label_width ラベルの幅を指定します。
@param labels ブロックが Benchmark::Tms オブジェクトの配列を返す場合に指定します。

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

n = 50000
Benchmark.bm do |x|
x.report { for i in 1..n; a = "1"; end }
x.report { n.t...

• Benchmark
• Benchmark::Tms

Kernel.#open(file, mode_enc = "r", perm = 0666) {|io| ... } -> object (415.0)

• 3.2

• モジュール関数

file をオープンして、IO（Fileを含む）クラスのインスタンスを返します。

file をオープンして、IO（Fileを含む）クラスのインスタンスを返します。

ブロックが与えられた場合、指定されたファイルをオープンし、
生成した IO オブジェクトを引数としてブロックを実行します。
ブロックの終了時や例外によりブロックを脱出するとき、
ファイルをクローズします。ブロックを評価した結果を返します。

ファイル名 file が `|' で始まる時には続く文字列をコマンドとして起動し、
コマンドの標準入出力に対してパイプラインを生成します

ファイル名が "|-" である時、open は Ruby の子プロセス
を生成し、その子プロセスとの間のパイプ(IOオブジェクト)を...

• File
• File::Constants
• IO
• Kernel

Benchmark.#benchmark(caption = "", label_width = nil, fmtstr = nil, *labels) {|rep| ...} -> [Benchmark::Tms] (379.0)

• 3.2

• モジュール関数

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

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

基本的には以下のように使います。
ブロックが Benchmark::Tms オブジェクトの配列を返した場合は、
それらの数値も追加の行に表示されます。

@param caption レポートの一行目に表示する文字列を指定します。
@param label_width ラベルの幅を指定します。
@param fmtstr フォーマット文字列を指定します。
この引数を省略すると Benchmark::FORMAT が使用されます。...

• Benchmark
• Benchmark::Report
• Benchmark::Tms

Open3.#popen3(*cmd) {|stdin, stdout, stderr, wait_thr| ... } -> () (379.0)

• 3.2

• モジュール関数

外部プログラム cmd を実行し、そのプロセスの標準入力、標準出力、標準エラー 出力に接続されたパイプと実行したプロセスを待つためのスレッドを 4 要素の 配列で返します。

外部プログラム cmd を実行し、そのプロセスの標準入力、標準出力、標準エラー
出力に接続されたパイプと実行したプロセスを待つためのスレッドを 4 要素の
配列で返します。

require 'open3'
stdin, stdout, stderr, wait_thr = *Open3.popen3("/usr/bin/nroff -man")

@param cmd 実行するコマンドを指定します。

@return ブロックを指定した場合はブロックの最後に評価された値を返します。
ブロックを指定しなかった場合は標準入力、標準出力、標準エラー出
力と...

• Open3

絞り込み条件を変える

Syslog.#mask -> Integer | nil (379.0)

• 3.2

• モジュール関数

ログの優先度のマスクを取得または設定します。 マスクは永続的であり、 Syslog.openやSyslog.close ではリセットされません。

ログの優先度のマスクを取得または設定します。
マスクは永続的であり、
Syslog.openやSyslog.close
ではリセットされません。

@param mask ログの優先度のマスクを設定します。

@raise RuntimeError syslog がオープンされていない場合、発生します。

使用例

require 'syslog'
include Syslog::Constants
# ログの場所は実行環境によって異なる。詳しくはsyslog.conf を参照
log = '/var/log/ftp.log'

Syslog.open('ftpd', L...

• Syslog

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

• 3.2

• モジュール関数

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

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

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

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

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

• Timeout
• Timeout::Error
• resolv-replace

Timeout.#timeout(sec, exception_class, message) {|i| ... } -> object (364.0)

• 3.2

• モジュール関数

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

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

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

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

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

• Timeout
• Timeout::Error
• resolv-replace

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

• 3.2

• モジュール関数

グローバル変数 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

Syslog.#open(ident=$0, options=Syslog::LOG_PID|Syslog::LOG_CONS, facility=Syslog::LOG_USER) -> self (352.0)

• 3.2

• モジュール関数

与えられた引数でsyslogを開きます。以降、他の Syslog モジュール関数が使 用可能となります。

与えられた引数でsyslogを開きます。以降、他の Syslog モジュール関数が使
用可能となります。

ブロック付きで呼ばれた場合は、self を引数としてブロックを実行し、
最後に Syslog.#close を行います。

syslog の詳細については syslog(3) を参照してください。

@param ident すべてのログにつく識別子で、どのプログラムから送られ
たログなのかを識別するために使われる文字列を指定します。
指定しない場合はプログラム名が使われます。

@param options Syslog.open ...

• RuntimeError
• Syslog
• Syslog::Constants

絞り込み条件を変える

Kernel.#catch {|tag| .... } -> object (346.0)

• 3.2

• モジュール関数

Kernel.#throwとの組み合わせで大域脱出を行います。 catch はブロックを実行します。

Kernel.#throwとの組み合わせで大域脱出を行います。 catch はブロックを実行します。

ブロックの実行中に tag と同一のオブジェクトを引数とする Kernel.#throw が行われた
場合は、その throw の第二引数を戻り値として、ブロックの実行を終了します。

主にネストしたループから一気に脱出するのに使用します。

引数を省略した場合、タグとなるオブジェクトが内部で生成され、ブロックパラメータ tag に
渡されます。

@param tag タグとなる任意のオブジェクトです。
@return ブロックの返り値か、対応するthrowの第二引数を返り値として返しま...

• Kernel

Kernel.#catch(tag) {|tag| .... } -> object (346.0)

• 3.2

• モジュール関数

Kernel.#throwとの組み合わせで大域脱出を行います。 catch はブロックを実行します。

Kernel.#throwとの組み合わせで大域脱出を行います。 catch はブロックを実行します。

ブロックの実行中に tag と同一のオブジェクトを引数とする Kernel.#throw が行われた
場合は、その throw の第二引数を戻り値として、ブロックの実行を終了します。

主にネストしたループから一気に脱出するのに使用します。

引数を省略した場合、タグとなるオブジェクトが内部で生成され、ブロックパラメータ tag に
渡されます。

@param tag タグとなる任意のオブジェクトです。
@return ブロックの返り値か、対応するthrowの第二引数を返り値として返しま...

• Kernel

Benchmark.#bmbm(width = 0) {|job| ... } -> [Benchmark::Tms] (343.0)

• 3.2

• モジュール関数

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

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

ベンチマークの結果は GC の影響によって歪められてしまうことがあります。
このメソッドは与えられたブロックを二度実行する事によってこの影響を最小化します。
一回目は実行環境を安定化するためにリハーサルとして実行します。二回目は本番として
実行します。

二回目のブロック実行の前に GC.start を実行しますが、この実行時間は計測には
含まれません。しかし、実際にはこのメソッドを使用しても、GC などの影響を分離する
ことは保証されません。

@param width ラベルの幅を...

• Benchmark
• Benchmark::Job

JSON.#dump(object, io = nil, limit = nil) -> String | IO (343.0)

• 3.2

• モジュール関数

与えられたオブジェクトを JSON 形式の文字列に変換してダンプします。

与えられたオブジェクトを JSON 形式の文字列に変換してダンプします。

与えられたオブジェクトを引数として JSON.#generate を呼び出します。


@param object ダンプするオブジェクトを指定します。

@param io IO のように write メソッドを実装しているオブジェクトを指定します。

@param limit 指定した場合、limit 段以上深くリンクしたオブジェクトをダンプできません。

@raise ArgumentError オブジェクトのネストの深さが limit を越えた場合に発生します。

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

• IO
• JSON
• Marshal

Kernel.#loop { ... } -> object | nil (343.0)

• 3.2

• モジュール関数

(中断されない限り)永遠にブロックの評価を繰り返します。 ブロックが指定されなければ、代わりに Enumerator を返します。

(中断されない限り)永遠にブロックの評価を繰り返します。
ブロックが指定されなければ、代わりに Enumerator を返します。

//emlist[例][ruby]{
loop do
print "Input: "
line = gets
break if !line or line =~ /^qQ/
# ...
end
//}

与えられたブロック内で StopIteration を Kernel.#raise すると
ループを終了して Enumerator が最後に返した値を返します。
ループを終了させる場合、通常は break を使用してください。

//emlist...

• Enumerator
• Kernel
• StopIteration

絞り込み条件を変える

Signal.#signame(signo) -> String | nil (343.0)

• 3.2

• モジュール関数

引数で指定されたシグナル番号をシグナル名に変換して返します。 対応するシグナル番号が存在しない場合は nil を返します。

引数で指定されたシグナル番号をシグナル名に変換して返します。
対応するシグナル番号が存在しない場合は nil を返します。

Signal.trap("INT") { |signo| puts Signal.signame(signo) }
Process.kill("INT", 0)
# => INT

@see Signal.#list

• Signal

WEBrick::HTTPAuth.#basic_auth(req, res, realm) {|user, pass| ... } -> nil (343.0)

• 3.2

• モジュール関数

Basic 認証を行うためのメソッドです。

Basic 認証を行うためのメソッドです。

与えられたブロックは user, pass をブロックパラメータとして渡されて評価されます。
ブロックの評価結果が真である場合、認証が成功したことになります。
ブロックの評価結果が偽である場合、認証は失敗したことになり、例外が発生します。

@param req クライアントからのリクエストを表す WEBrick::HTTPRequest オブジェクトを指定します。

@param res WEBrick::HTTPResponse オブジェクトを指定します。

@param realm 認証のレルムを文字列で指定します。

@raise WEB...

• WEBrick::HTTPAuth
• WEBrick::HTTPRequest
• WEBrick::HTTPResponse

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

• 3.2

• モジュール関数

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

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

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

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

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

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

• Kernel

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

• 3.2

• モジュール関数

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

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

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

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

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

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

• Kernel

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

• 3.2

• モジュール関数

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

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

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

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

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

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

• Kernel
• Proc
• Symbol

絞り込み条件を変える

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

• 3.2

• モジュール関数

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

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

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

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

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

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

• Kernel
• Proc
• Symbol

Find.#find(*dirs, ignore_error: true) {|file| ... } -> nil (325.0)

• 3.2

• モジュール関数

find(1) のように dir 配下のすべてのファイルや ディレクトリを一つずつ引数 file に渡してブロックを実行します。

find(1) のように dir 配下のすべてのファイルや
ディレクトリを一つずつ引数 file に渡してブロックを実行します。

ディレクトリのシンボリックリンクは辿りません。
また file に渡される順序は不定です。

ブロックを省略した場合は Enumerator を返します。

@param dirs 探索するディレクトリを一つ以上指定します。

@param ignore_error 探索中に発生した例外を無視するかどうかを指定します。

例:

require 'find'

Find.find('/tmp') {|f|
Find.prune if f ==...

• Enumerator
• Find

Open3.#pipeline_r(*cmds) {|last_stdout, wait_thrs| ... } -> () (325.0)

• 3.2

• モジュール関数

指定したコマンドのリストをパイプで繋いで順番に実行します。最後の コマンドの標準出力を受けとる事ができます。

指定したコマンドのリストをパイプで繋いで順番に実行します。最後の
コマンドの標準出力を受けとる事ができます。

@param cmds 実行するコマンドのリストを指定します。それぞれのコマンドは
以下のように String か Array で指定します。
commandline にはコマンド全体(例. "nroff -man")を表す
String を指定します。
options には Hash で指定します。
env には環境変数を Hash で指定します。
...

• Open3

Open3.#pipeline_rw(*cmds) {|first_stdin, last_stdout, wait_thrs| ... } -> () (325.0)

• 3.2

• モジュール関数

指定したコマンドのリストをパイプで繋いで順番に実行します。最初の コマンドの標準入力に書き込む事も最後のコマンドの標準出力を受けとる事も できます。

指定したコマンドのリストをパイプで繋いで順番に実行します。最初の
コマンドの標準入力に書き込む事も最後のコマンドの標準出力を受けとる事も
できます。

@param cmds 実行するコマンドのリストを指定します。それぞれのコマンドは
以下のように String か Array で指定します。
commandline にはコマンド全体(例. "nroff -man")を表す
String を指定します。
options には Hash で指定します。
env には環境変数を...

• Open3

Open3.#pipeline_start(*cmds) {|wait_thrs| ... } -> () (325.0)

• 3.2

• モジュール関数

指定したコマンドのリストをパイプで繋いで順番に実行します。

指定したコマンドのリストをパイプで繋いで順番に実行します。

@param cmds 実行するコマンドのリストを指定します。それぞれのコマンドは
以下のように String か Array で指定します。
commandline にはコマンド全体(例. "nroff -man")を表す
String を指定します。
options には Hash で指定します。
env には環境変数を Hash で指定します。
cmdname にはコマンド名を表す ...

• Open3

絞り込み条件を変える

Open3.#pipeline_w(*cmds) {|first_stdin, wait_thrs| ... } -> () (325.0)

• 3.2

• モジュール関数

指定したコマンドのリストをパイプで繋いで順番に実行します。最初の コマンドの標準入力に書き込む事ができます。

指定したコマンドのリストをパイプで繋いで順番に実行します。最初の
コマンドの標準入力に書き込む事ができます。

@param cmds 実行するコマンドのリストを指定します。それぞれのコマンドは
以下のように String か Array で指定します。
commandline にはコマンド全体(例. "nroff -man")を表す
String を指定します。
options には Hash で指定します。
env には環境変数を Hash で指定します。
...

• Open3

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

• 3.2

• モジュール関数

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

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

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

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

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

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

• Kernel

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

• 3.2

• モジュール関数

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

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

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

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

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

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

• Kernel

Process.#wait(pid = -1, flags = 0) -> Integer | nil (316.0)

• 3.2

• モジュール関数

pid で指定される特定の子プロセスの終了を待ち、そのプロセスが 終了した時に pid を返します。 wait2, waitpid2 は子プロセスの pid と終了ステータスを表す Process::Status オブジェクトの配列を返します。 ノンブロッキングモードで子プロセスがまだ終了していない時には nil を返します。

pid で指定される特定の子プロセスの終了を待ち、そのプロセスが
終了した時に pid を返します。
wait2, waitpid2 は子プロセスの pid と終了ステータスを表す
Process::Status オブジェクトの配列を返します。
ノンブロッキングモードで子プロセスがまだ終了していない時には
nil を返します。

$? に終了した子プロセスの Process::Status オブジェクトがセットされます。

@param pid 子プロセスのプロセス ID を整数で指定します。
0 以上なら指定されたプロセス ID の子プロセスを待ちます。
0 な...

• Process
• Process::Status

Process.#wait2(pid = -1, flags = 0) -> [Integer, Process::Status] | nil (316.0)

• 3.2

• モジュール関数

pid で指定される特定の子プロセスの終了を待ち、そのプロセスが 終了した時に pid を返します。 wait2, waitpid2 は子プロセスの pid と終了ステータスを表す Process::Status オブジェクトの配列を返します。 ノンブロッキングモードで子プロセスがまだ終了していない時には nil を返します。

pid で指定される特定の子プロセスの終了を待ち、そのプロセスが
終了した時に pid を返します。
wait2, waitpid2 は子プロセスの pid と終了ステータスを表す
Process::Status オブジェクトの配列を返します。
ノンブロッキングモードで子プロセスがまだ終了していない時には
nil を返します。

$? に終了した子プロセスの Process::Status オブジェクトがセットされます。

@param pid 子プロセスのプロセス ID を整数で指定します。
0 以上なら指定されたプロセス ID の子プロセスを待ちます。
0 な...

• Process
• Process::Status

絞り込み条件を変える

Process.#waitpid(pid = -1, flags = 0) -> Integer | nil (316.0)

• 3.2

• モジュール関数

pid で指定される特定の子プロセスの終了を待ち、そのプロセスが 終了した時に pid を返します。 wait2, waitpid2 は子プロセスの pid と終了ステータスを表す Process::Status オブジェクトの配列を返します。 ノンブロッキングモードで子プロセスがまだ終了していない時には nil を返します。

pid で指定される特定の子プロセスの終了を待ち、そのプロセスが
終了した時に pid を返します。
wait2, waitpid2 は子プロセスの pid と終了ステータスを表す
Process::Status オブジェクトの配列を返します。
ノンブロッキングモードで子プロセスがまだ終了していない時には
nil を返します。

$? に終了した子プロセスの Process::Status オブジェクトがセットされます。

@param pid 子プロセスのプロセス ID を整数で指定します。
0 以上なら指定されたプロセス ID の子プロセスを待ちます。
0 な...

• Process
• Process::Status

Process.#waitpid2(pid = -1, flags = 0) -> [Integer, Process::Status] | nil (316.0)

• 3.2

• モジュール関数

pid で指定される特定の子プロセスの終了を待ち、そのプロセスが 終了した時に pid を返します。 wait2, waitpid2 は子プロセスの pid と終了ステータスを表す Process::Status オブジェクトの配列を返します。 ノンブロッキングモードで子プロセスがまだ終了していない時には nil を返します。

pid で指定される特定の子プロセスの終了を待ち、そのプロセスが
終了した時に pid を返します。
wait2, waitpid2 は子プロセスの pid と終了ステータスを表す
Process::Status オブジェクトの配列を返します。
ノンブロッキングモードで子プロセスがまだ終了していない時には
nil を返します。

$? に終了した子プロセスの Process::Status オブジェクトがセットされます。

@param pid 子プロセスのプロセス ID を整数で指定します。
0 以上なら指定されたプロセス ID の子プロセスを待ちます。
0 な...

• Process
• Process::Status

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

• 3.2

• モジュール関数

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

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

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

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

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

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

@see Kernel.#set_trace_func,K...

• Kernel
• Range

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

• 3.2

• モジュール関数

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

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

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

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

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

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

@see Kernel.#set_trace_func,K...

• Kernel
• Range

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

• 3.2

• モジュール関数

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

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

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

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

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

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

@see Kernel.#set_trace_func,K...

• Kernel
• Range

絞り込み条件を変える

Kernel.#rand(max = 0) -> Integer | Float (313.0)

• 3.2

• モジュール関数

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

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

最初の形式では
max が 0 の場合は 0.0 以上 1.0 未満の実数を、正の整数の場合は 0 以上 max 未満の整数を返します。
それ以外の値を指定した場合は max.to_int の絶対値が指定されたものとして扱います。

二番目の形式では range で指定された範囲の値を返します。
range の始端と終端が共に整数の場合は整数を、少なくとも片方が実数の場合は実数を返します。
range に含まれる数が無い場合は nil を返します。

まだ Kernel.#srand が呼ばれていなければ自動的に呼び出します。

擬似乱数生成器として Random...

• Kernel
• Random
• Range

Syslog.#facility -> Integer | nil (313.0)

• 3.2

• モジュール関数

最後のopenで与えられた対応する引数を返します。

最後のopenで与えられた対応する引数を返します。

使用例
require 'syslog'

Syslog.open("syslogtest")
p Syslog.ident #=> "syslogtest"
p Syslog.options #=> 3
p Syslog.facility #=> 8

• Syslog

Syslog.#ident -> String | nil (313.0)

• 3.2

• モジュール関数

最後のopenで与えられた対応する引数を返します。

最後のopenで与えられた対応する引数を返します。

使用例
require 'syslog'

Syslog.open("syslogtest")
p Syslog.ident #=> "syslogtest"
p Syslog.options #=> 3
p Syslog.facility #=> 8

• Syslog

Syslog.#options -> Integer | nil (313.0)

• 3.2

• モジュール関数

最後のopenで与えられた対応する引数を返します。

最後のopenで与えられた対応する引数を返します。

使用例
require 'syslog'

Syslog.open("syslogtest")
p Syslog.ident #=> "syslogtest"
p Syslog.options #=> 3
p Syslog.facility #=> 8

• Syslog

Etc.#group -> Etc::Group | nil (310.0)

• 3.2

• モジュール関数

/etc/group ファイルから読み込んだエントリを一つ返します。

/etc/group ファイルから読み込んだエントリを一つ返します。

最初の呼び出しでは、先頭のエントリを返します。それ以降の呼び出しでは、
呼び出す度に次のエントリを順に返します。ファイルの終端に達すると nil を返します。

@raise RuntimeError /etc/group ファイルがロックされている場合に発生します。

@see Etc.#getgrent, getgrent(3)

• Etc

絞り込み条件を変える

Etc.#group {|gr| ... } -> () (310.0)

• 3.2

• モジュール関数

全てのグループエントリを順にアクセスするためのイテレータです。

全てのグループエントリを順にアクセスするためのイテレータです。

• Etc

Etc.#passwd -> Etc::Passwd | nil (310.0)

• 3.2

• モジュール関数

/etc/passwd から読み込んだエントリを一つ返します。

/etc/passwd から読み込んだエントリを一つ返します。

最初の呼び出しでは、先頭のエントリを返します。それ以降の呼び出しでは、
呼び出す度に次のエントリを順に返します。ファイルの終端に達すると nil を返します。

@raise RuntimeError /etc/passwd ファイルがロックされている場合に発生します。

@see Etc.#getpwent, getpwent(3)

• Etc

Etc.#passwd {|pw| ... } -> () (310.0)

• 3.2

• モジュール関数

全ての passwd エントリを順にアクセスするためのイテレータです。

全ての passwd エントリを順にアクセスするためのイテレータです。

• Etc

FileUtils.#cd(dir, options = {}) {|dir| .... } -> object (310.0)

• 3.2

• モジュール関数

プロセスのカレントディレクトリを dir に変更します。

プロセスのカレントディレクトリを dir に変更します。

ブロックとともに呼び出された時はブロック終了後に
元のディレクトリに戻ります。

@param dir ディレクトリを指定します。

@param options :verbose が指定できます。
c:FileUtils#options

//emlist[][ruby]{
require 'fileutils'
FileUtils.cd('/', verbose: true) # chdir and report it
//}

• FileUtils

FileUtils.#chdir(dir, options = {}) {|dir| .... } -> object (310.0)

• 3.2

• モジュール関数

プロセスのカレントディレクトリを dir に変更します。

プロセスのカレントディレクトリを dir に変更します。

ブロックとともに呼び出された時はブロック終了後に
元のディレクトリに戻ります。

@param dir ディレクトリを指定します。

@param options :verbose が指定できます。
c:FileUtils#options

//emlist[][ruby]{
require 'fileutils'
FileUtils.cd('/', verbose: true) # chdir and report it
//}

• FileUtils

絞り込み条件を変える

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

• 3.2

• モジュール関数

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

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

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

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

• Float
• Integer
• Kernel

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

• 3.2

• モジュール関数

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

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

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

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

• Float
• Integer
• Kernel

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

• 3.2

• モジュール関数

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

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

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

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

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

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

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

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

• Complex
• Kernel

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

• 3.2

• モジュール関数

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

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

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

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

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

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

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

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

• Complex
• Kernel

Kernel.#caller_locations(range) -> [Thread::Backtrace::Location] | nil (310.0)

• 3.2

• モジュール関数

現在のフレームを Thread::Backtrace::Location の配列で返します。引 数で指定した値が範囲外の場合は nil を返します。

現在のフレームを Thread::Backtrace::Location の配列で返します。引
数で指定した値が範囲外の場合は nil を返します。

@param start 開始フレームの位置を数値で指定します。

@param length 取得するフレームの個数を指定します。

@param range 取得したいフレームの範囲を示す Range オブジェクトを指定します。

//emlist[例][ruby]{
def test1(start, length)
locations = caller_locations(start, length)
p locations
...

• Kernel
• Range
• Thread::Backtrace::Location

絞り込み条件を変える

Kernel.#caller_locations(start = 1, length = nil) -> [Thread::Backtrace::Location] | nil (310.0)

• 3.2

• モジュール関数

現在のフレームを Thread::Backtrace::Location の配列で返します。引 数で指定した値が範囲外の場合は nil を返します。

現在のフレームを Thread::Backtrace::Location の配列で返します。引
数で指定した値が範囲外の場合は nil を返します。

@param start 開始フレームの位置を数値で指定します。

@param length 取得するフレームの個数を指定します。

@param range 取得したいフレームの範囲を示す Range オブジェクトを指定します。

//emlist[例][ruby]{
def test1(start, length)
locations = caller_locations(start, length)
p locations
...

• Kernel
• Range
• Thread::Backtrace::Location

Kernel.#fork -> Integer | nil (310.0)

• 3.2

• モジュール関数

fork(2) システムコールを使ってプロセスの複製を作 ります。親プロセスでは子プロセスのプロセスIDを、子プロセスでは nil を返します。ブロックを指定して呼び出した場合には、生成し た子プロセスでブロックを評価します。

fork(2) システムコールを使ってプロセスの複製を作
ります。親プロセスでは子プロセスのプロセスIDを、子プロセスでは
nil を返します。ブロックを指定して呼び出した場合には、生成し
た子プロセスでブロックを評価します。

fork 前に STDOUT と STDERR を IO#flush します。

@raise NotImplementedError 実行環境がこのメソッドに対応していないとき発生します。

//emlist[ブロックを指定しなかった場合][ruby]{
if child_pid = fork
puts "parent process. pid: #{Proc...

• Kernel

Kernel.#fork { ... } -> Integer | nil (310.0)

• 3.2

• モジュール関数

fork(2) システムコールを使ってプロセスの複製を作 ります。親プロセスでは子プロセスのプロセスIDを、子プロセスでは nil を返します。ブロックを指定して呼び出した場合には、生成し た子プロセスでブロックを評価します。

fork(2) システムコールを使ってプロセスの複製を作
ります。親プロセスでは子プロセスのプロセスIDを、子プロセスでは
nil を返します。ブロックを指定して呼び出した場合には、生成し
た子プロセスでブロックを評価します。

fork 前に STDOUT と STDERR を IO#flush します。

@raise NotImplementedError 実行環境がこのメソッドに対応していないとき発生します。

//emlist[ブロックを指定しなかった場合][ruby]{
if child_pid = fork
puts "parent process. pid: #{Proc...

• Kernel

PTY.#getpty(command) {|read, write, pid| ... } -> nil (310.0)

• 3.2

• モジュール関数

擬似 tty を確保し、指定されたコマンドをその擬似 tty の向こうで実行し、配列を返します。

擬似 tty を確保し、指定されたコマンドをその擬似 tty の向こうで実行し、配列を返します。

プラットフォームに依存しますが、対応していれば、作られたプロセスはセッションリーダーに
なり、その制御端末は作成された擬似 tty に設定されます。


@param command 擬似 tty 上で実行するコマンド

@return 返値は3つの要素からなる配列です。最初の要素は擬似 tty から
読み出すための IO オブジェクト、2番目の要素は書きこむための IO オブジェクト、
3番目の要素は子プロセスのプロセス ID です。
このメソ...

• PTY

PTY.#spawn(command) {|read, write, pid| ... } -> nil (310.0)

• 3.2

• モジュール関数

擬似 tty を確保し、指定されたコマンドをその擬似 tty の向こうで実行し、配列を返します。

擬似 tty を確保し、指定されたコマンドをその擬似 tty の向こうで実行し、配列を返します。

プラットフォームに依存しますが、対応していれば、作られたプロセスはセッションリーダーに
なり、その制御端末は作成された擬似 tty に設定されます。


@param command 擬似 tty 上で実行するコマンド

@return 返値は3つの要素からなる配列です。最初の要素は擬似 tty から
読み出すための IO オブジェクト、2番目の要素は書きこむための IO オブジェクト、
3番目の要素は子プロセスのプロセス ID です。
このメソ...

• PTY

絞り込み条件を変える

DRb.#primary_server -> DRb::DRbServer|nil (307.0)

• 3.2

• モジュール関数

ローカルプロセスのプライマリサーバーを返します。

ローカルプロセスのプライマリサーバーを返します。

プライマリサーバとは DRb.#start_service によって
起動されるサーバです。

サーバが動いていない場合は nil を返します。

@see DRb.#stop_service

• DRb

DRb.#thread -> Thread|nil (307.0)

• 3.2

• モジュール関数

プライマリサーバが動作しているスレッドを返します。

プライマリサーバが動作しているスレッドを返します。

プライマリサーバが存在しない場合は nil を返します。

@see DRb.#primary_server

• DRb

Etc.#confstr(name) -> String | nil (307.0)

• 3.2

• モジュール関数

confstr(3) で取得したシステム設定変数の値を返します。

confstr(3) で取得したシステム設定変数の値を返します。

@param name Etc モジュールの CS_ で始まる定数のいずれかを指定します。

引数 name に対応する設定が行われていない状態の場合は nil を返します。
(confstr(3) が -1 を返し、errno が設定されていない場合)

//emlist[][ruby]{
require "etc"
Etc.confstr(Etc::CS_PATH) # => "/bin:/usr/bin"

# GNU/Linux
Etc.confstr(Etc::CS_GNU_LIBC_VERSION) # => "...

• Etc

Etc.#getgrent -> Etc::Group | nil (307.0)

• 3.2

• モジュール関数

/etc/group ファイルから読み込んだエントリを一つ返します。

/etc/group ファイルから読み込んだエントリを一つ返します。

最初の呼び出しでは、先頭のエントリを返します。それ以降の呼び出しでは、
呼び出す度に次のエントリを順に返します。ファイルの終端に達すると nil を返します。

処理が終了したときは Etc.#endgrent を呼び出すようにしてください。

@see getgrent(3), Etc::Group

• Etc
• Etc::Group

Etc.#getlogin -> String | nil (307.0)

• 3.2

• モジュール関数

自分の login 名を返します。得られなかった場合は nil を返します。

自分の login 名を返します。得られなかった場合は nil を返します。

getlogin は su(1) などでログイン時のユーザとは異なるユーザになっている場合、
現在ではなくログイン時のユーザを返します。

このメソッドが失敗した場合は Etc.#getpwuid に
フォールバックするとよいでしょう。

たとえば、環境変数 USER などもあわせて、以下のようにフォールバックできます。

//emlist[][ruby]{
require "etc"
login_user = ENV['USER'] || ENV['LOGNAME'] || Etc.getlogin || Et...

• Etc

絞り込み条件を変える

Etc.#getpwent -> Etc::Passwd | nil (307.0)

• 3.2

• モジュール関数

/etc/passwd から読み込んだエントリを一つ返します。

/etc/passwd から読み込んだエントリを一つ返します。

最初の呼び出しでは、先頭のエントリを返します。それ以降の呼び出しでは、
呼び出す度に次のエントリを順に返します。ファイルの終端に達すると nil を返します。

処理が終了したときは Etc.#endpwent を呼び出すようにしてください。

@see getpwent(3)

• Etc

Etc.#sysconf(name) -> Integer | nil (307.0)

• 3.2

• モジュール関数

sysconf(3) で取得したシステム設定変数の値を返します。

sysconf(3) で取得したシステム設定変数の値を返します。

引数 name が制限に関する設定値であり、設定が制限がない状態の場合は nil
を返します。(sysconf(3) が -1 を返し、errno が設定されていない
場合)

@param name Etc モジュールの SC_ で始まる定数のいずれかを指定します。

//emlist[][ruby]{
require "etc"
Etc.sysconf(Etc::SC_ARG_MAX) # => 2097152

# Number of processors.
# It is not standardized.
Etc....

• Etc

Etc.#sysconfdir -> String | nil (307.0)

• 3.2

• モジュール関数

システムの設定ディレクトリを返します。

システムの設定ディレクトリを返します。

//emlist[][ruby]{
require 'etc'
p Etc.sysconfdir # => "/etc"
//}

主に "/etc" を返しますが、Ruby をソースからビルドした場合は異なるディレ
クトリを返す場合があります。例えば、Ruby を /usr/local にインストールし
た場合は、"/usr/local/etc" を返します。
Windows では常にシステムで提供されたディレクトリを返します。

• Etc

Etc.#systmpdir -> String | nil (307.0)

• 3.2

• モジュール関数

システムのテンポラリディレクトリを返します。

システムのテンポラリディレクトリを返します。

//emlist[][ruby]{
require 'etc'
p Etc.systmpdir # => "/tmp"
//}

• Etc

FileTest.#size?(file) -> Integer | nil (307.0)

• 3.2

• モジュール関数

ファイルのサイズを返します。ファイルが存在しない時や ファイルのサイズが0の時には nil を返します。

ファイルのサイズを返します。ファイルが存在しない時や
ファイルのサイズが0の時には nil を返します。

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

@raise IOError 指定された IO オブジェクト file が既に close されていた場合に発生します。

//emlist[例][ruby]{
IO.write("testfile", "test")
FileTest.size?("testfile") # => 4
File.delete("testfile")
FileTest.size?("testfile") ...

• FileTest

絞り込み条件を変える

FileTest.#world_readable?(path) -> Integer | nil (307.0)

• 3.2

• モジュール関数

path が全てのユーザから読めるならばそのファイルのパーミッションを表す 整数を返します。そうでない場合は nil を返します。

path が全てのユーザから読めるならばそのファイルのパーミッションを表す
整数を返します。そうでない場合は nil を返します。

整数の意味はプラットフォームに依存します。

@param path パスを表す文字列を指定します。

m = FileTest.world_readable?("/etc/passwd")
"%o" % m # => "644"

• FileTest

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

• 3.2

• モジュール関数

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

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

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

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

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

• Float
• Kernel

Kernel.#Integer(arg, base = 0, exception: true) -> Integer | nil (307.0)

• 3.2

• モジュール関数

引数を整数 に変換した結果を返します。

引数を整数
に変換した結果を返します。

引数が数値の場合は直接変換し（小数点以下切り落とし）、
文字列の場合は、進数を表す接頭辞を含む整数表現とみなせる文字列のみ
変換します。

数値と文字列以外のオブジェクトに対しては arg.to_int, arg.to_i を
この順に使用して変換します。

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

@param base 基数として0か2から36の整数を指定します(引数argに文字列を指
定した場合のみ)。省略するか0を指定した場合はプリフィクスか
ら基数を判断します。その場合に認識できる...

• Integer
• Kernel

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

• 3.2

• モジュール関数

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

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

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

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

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

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

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

• ArgumentError
• Kernel
• Rational

Kernel.#__callee__ -> Symbol | nil (307.0)

• 3.2

• モジュール関数

現在のメソッド名を返します。 メソッドの外で呼ばれると nil を返します。

現在のメソッド名を返します。
メソッドの外で呼ばれると nil を返します。

//emlist[例][ruby]{
def foo
p __callee__
end
alias :bar :foo
foo # => :foo
bar # => :bar
p __callee__ # => nil
//}

Kernel.#__method__ とは異なり、現在のメソッド名が alias されたメ
ソッドの場合には alias 先のメソッド名を返します。

@see Kernel.#__method__

• Kernel

絞り込み条件を変える

Kernel.#__dir__ -> String | nil (307.0)

• 3.2

• モジュール関数

現在のソースファイル(__FILE__)のあるディレクトリ名を正規化された絶対パ スで返します。シンボリックリンクも解決されます。また、__FILE__ が nil の場合は nil を返します。

現在のソースファイル(__FILE__)のあるディレクトリ名を正規化された絶対パ
スで返します。シンボリックリンクも解決されます。また、__FILE__ が nil
の場合は nil を返します。

• Kernel

Kernel.#__method__ -> Symbol | nil (307.0)

• 3.2

• モジュール関数

現在のメソッド名を返します。 メソッドの外で呼ばれると nil を返します。

現在のメソッド名を返します。
メソッドの外で呼ばれると nil を返します。

//emlist[例][ruby]{
def foo
p __method__
end
alias :bar :foo
foo #=> :foo
bar #=> :foo
p __method__ #=> nil
//}

現在のメソッド名が alias されたメソッドの場合でも alias 元のメソッド名
を返します。

• Kernel

Kernel.#autoload?(const_name) -> String | nil (307.0)

• 3.2

• モジュール関数

const_name が Kernel.#autoload 設定されているか調べます。

const_name が Kernel.#autoload 設定されているか調べます。

autoload 設定されていて、autoload 定数がまだ定義されてない(ロードされていない)
ときにそのパス名を返します。

autoload 設定されていないか、ロード済みなら nil を返します。

@param const_name 定数をString または Symbol で指定します。

//emlist[例][ruby]{
# ------- /tmp/foo.rb ---------
class Foo
class Bar
end
end
# ----- end of /tm...

• Kernel

Kernel.#callcc {|cont| .... } -> object (307.0)

• 3.2

• モジュール関数

継続を作成します。 Continuation を参照してください。

継続を作成します。 Continuation を参照してください。

• Continuation
• Kernel

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

• 3.2

• モジュール関数

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

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

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

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

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

• ARGF
• Kernel

絞り込み条件を変える

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

• 3.2

• モジュール関数

$_.gsub とほぼ同じですが、置換が発生したときは、$_の内容を置き換える点が異なります。 コマンドラインオプションで -p または -n を指定した時のみ定義されます。

$_.gsub とほぼ同じですが、置換が発生したときは、$_の内容を置き換える点が異なります。
コマンドラインオプションで -p または -n を指定した時のみ定義されます。

暗号的になりすぎるきらいがあるため、このメソッドの使用は推奨されていません。
今後はより明示的な $_.gsub を使ってください。

$_.gsub とこのメソッド gsub は以下の点で違いがあります。

* gsub は $_ の値をコピーして、コピーの方を更新し、
$_ に再代入します。


@param pattern 置き換える文字列のパターンを表す文字列か正規表現。
...

• Kernel

Kernel.#p(*arg) -> object | Array (307.0)

• 3.2

• モジュール関数

引数を人間に読みやすい形に整形して改行と順番に標準出力 $stdout に出力します。主にデバッグに使用します。

引数を人間に読みやすい形に整形して改行と順番に標準出力 $stdout に出力します。主にデバッグに使用します。

引数の inspect メソッドの返り値と改行を順番に出力します。つまり以下のコードと同じです。

//emlist[例][ruby]{
print arg[0].inspect, "\n", arg[1].inspect, "\n" #, ...
//}

整形に用いられるObject#inspectは普通に文字列に変換すると
区別がつかなくなるようなクラス間の差異も表現できるように工夫されています。

p に引数を与えずに呼び出した場合は特に何もしません。

@param ...

• Kernel

Kernel.#select(reads, writes = [], excepts = [], timeout = nil) -> [[IO]] | nil (307.0)

• 3.2

• モジュール関数

IO.select と同じです。

IO.select と同じです。

@param reads IO.select 参照
@param writes IO.select 参照
@param excepts IO.select 参照
@param timeout IO.select 参照


@see IO.select

• Kernel

Kernel.#sub(pattern) {|matched| ... } -> String (307.0)

• 3.2

• モジュール関数

$_.sub とほぼ同じですが、置換が発生したときは、$_の内容を置き換える点が異なります。 コマンドラインオプションで -p または -n を指定した時のみ定義されます。

$_.sub とほぼ同じですが、置換が発生したときは、$_の内容を置き換える点が異なります。
コマンドラインオプションで -p または -n を指定した時のみ定義されます。

暗号的になりすぎるきらいがあるため、このメソッドの使用は推奨されていません。
今後はより明示的な $_.sub を使ってください。

@raise ArgumentError replace を指定しなかった場合に発生します。

$_.sub とこのメソッド sub は以下の点で違いがあります。

* sub は $_ の値をコピーして、コピーの方を更新し、
$_ に再代入します。

@param patter...

• Kernel

ObjectSpace.#define_finalizer(obj) {|id| ...} -> Array (307.0)

• 3.2

• モジュール関数

obj が解放されるときに実行されるファイナライザ proc を 登録します。同じオブジェクトについて複数回呼ばれたときは置き換えで はなく追加登録されます。固定値 0 と proc を配列にして返します。

obj が解放されるときに実行されるファイナライザ proc を
登録します。同じオブジェクトについて複数回呼ばれたときは置き換えで
はなく追加登録されます。固定値 0 と proc を配列にして返します。

ブロックを指定した場合は、そのブロックがファイナライザになります。
obj の回収時にブロックは obj の ID (BasicObject#__id__)を引数とし
て実行されます。
しかし、後述の問題があるのでブロックでファイナライザを登録するのは難しいでしょう。

@param obj ファイナライザを登録したいオブジェクトを指定します。

@param proc ファイナライザ...

• ObjectSpace
• Proc
• spec/rubycmd
• tempfile

絞り込み条件を変える

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

• 3.2

• モジュール関数

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

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

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

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

//emlist[例...

• Fixnum
• Float
• ObjectSpace
• Symbol

Open3.#popen2(*cmd) {|stdin, stdout, wait_thr| ... } -> () (307.0)

• 3.2

• モジュール関数

cmdで指定されたコマンドを実行し、そのプロセスの標準入力・標準出力にパイ プをつなぎます。Open3.popen3に似ていますが、標準エラーを扱いません。

cmdで指定されたコマンドを実行し、そのプロセスの標準入力・標準出力にパイ
プをつなぎます。Open3.popen3に似ていますが、標準エラーを扱いません。

@param cmd 実行するコマンドを指定します。

@return ブロックを指定した場合はブロックの最後に評価された値を返します。
ブロックを指定しなかった場合は標準入力、標準出力に接続されたパ
イプと実行したプロセスを待つためのスレッドを返します。

Open3.#popen3と同様に引数に環境変数とオプションを指定してコマンド
を実行する事ができます。

@see Open3.#popen3
...

• Open3

Open3.#popen2e(*cmd) {|stdin, stdout_and_stderr, wait_thr| ... } -> () (307.0)

• 3.2

• モジュール関数

cmdで指定されたコマンドを実行し、そのプロセスの標準入力・標準出力と標準 エラーにパイプをつなぎます。Open3.popen3に似ていますが、標準出力と標準 エラーが1つの変数で扱われます。

cmdで指定されたコマンドを実行し、そのプロセスの標準入力・標準出力と標準
エラーにパイプをつなぎます。Open3.popen3に似ていますが、標準出力と標準
エラーが1つの変数で扱われます。

@param cmd 実行するコマンドを指定します。

@return ブロックを指定した場合はブロックの最後に評価された値を返します。
ブロックを指定しなかった場合は標準入力、標準出力と標準エラーに
接続されたパイプと実行したプロセスを待つためのスレッドを返しま
す。

Open3.#popen3と同様に引数に環境変数とオプションを指定してコマンド
...

• Open3

OpenSSL::ASN1.#traverse(der) {|depth, off, hlen, len, constructed, tag_class, tag| ...} -> nil (307.0)

• 3.2

• モジュール関数

DER形式の文字列を解析し、そこに含まれる ASN.1 の値 のプロパティを引数として与えられたブロックを呼びだします。

DER形式の文字列を解析し、そこに含まれる ASN.1 の値
のプロパティを引数として与えられたブロックを呼びだします。

OpenSSL::ASN1.#decode_all のように、文字列に含まれる
全ての ASN.1 オブジェクトのインスタンスを解析します。

ブロックに渡される引数は以下の通りです。
* depth: 再帰の深さ
* off: 対象の値をエンコードした文字列の der の先頭からのオフセット
* hlen: エンコードされたデータのヘッダのバイト数
* len: エンコードされたデータの値フィールドのバイト数
* constructed:対象の AS...

• OpenSSL::ASN1
• Symbol

Process.#clock_gettime(clock_id, unit=:float_second) -> Float | Integer (307.0)

• 3.2

• モジュール関数

POSIX の clock_gettime() 関数の時間を返します。

POSIX の clock_gettime() 関数の時間を返します。

例:
p Process.clock_gettime(Process::CLOCK_MONOTONIC) #=> 896053.968060096

@param clock_id クロックの種類を以下の定数のいずれかで指定します。
サポートされている定数は OS やバージョンに依存します。

: Process::CLOCK_REALTIME
SUSv2 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 2.1, macOS...

• Process

絞り込み条件を変える

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

• 3.2

• モジュール関数

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

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

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

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

• Readline

WEBrick::HTTPAuth.#proxy_basic_auth(req, res, realm) {|user, pass| ... } -> nil (307.0)

• 3.2

• モジュール関数

プロクシの Basic 認証行うためのメソッドです。

プロクシの Basic 認証行うためのメソッドです。

与えられたブロックは user, pass をブロックパラメータとして渡されて評価されます。
ブロックの評価結果が真である場合、認証が成功したことになります。
ブロックの評価結果が偽である場合、認証は失敗したことになり、例外が発生します。

@param req クライアントからのリクエストを表す WEBrick::HTTPRequest オブジェクトを指定します。

@param res WEBrick::HTTPResponse オブジェクトを指定します。

@param realm 認証のレルムを文字列で指定します。

@rais...

• WEBrick::HTTPAuth
• WEBrick::HTTPRequest
• WEBrick::HTTPResponse

Win32::Resolv.#get_hosts_path -> String | nil (307.0)

• 3.2

• モジュール関数

hosts ファイルのパスを返します。ファイルが存在しない場合は nil を返します。

hosts ファイルのパスを返します。ファイルが存在しない場合は nil を返します。

例:

require "win32/resolv"
p Win32::Resolv.get_hosts_path #=> "C:\Windows\System32\drivers\etc\hosts"

• Win32::Resolv

ObjectSpace.#each_object -> Enumerator (118.0)

• 3.2

• モジュール関数

指定された klass と Object#kind_of? の関係にある全ての オブジェクトに対して繰り返します。引数が省略された時には全てのオブ ジェクトに対して繰り返します。 繰り返した数を返します。

指定された klass と Object#kind_of? の関係にある全ての
オブジェクトに対して繰り返します。引数が省略された時には全てのオブ
ジェクトに対して繰り返します。
繰り返した数を返します。

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

次のクラスのオブジェクトについては繰り返しません

* Fixnum
* Symbol
* TrueClass
* FalseClass
* NilClass

とくに、klass に Fixnum や Symbol などのクラスを指定した場合は、
何も繰り返さないことになります。
なお、Sy...

• Enumerator
• FalseClass
• Fixnum
• NilClass
• ObjectSpace
• Symbol
• TrueClass

ObjectSpace.#each_object(klass) -> Enumerator (118.0)

• 3.2

• モジュール関数

指定された klass と Object#kind_of? の関係にある全ての オブジェクトに対して繰り返します。引数が省略された時には全てのオブ ジェクトに対して繰り返します。 繰り返した数を返します。

指定された klass と Object#kind_of? の関係にある全ての
オブジェクトに対して繰り返します。引数が省略された時には全てのオブ
ジェクトに対して繰り返します。
繰り返した数を返します。

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

次のクラスのオブジェクトについては繰り返しません

* Fixnum
* Symbol
* TrueClass
* FalseClass
* NilClass

とくに、klass に Fixnum や Symbol などのクラスを指定した場合は、
何も繰り返さないことになります。
なお、Sy...

• Enumerator
• FalseClass
• Fixnum
• NilClass
• ObjectSpace
• Symbol
• TrueClass

絞り込み条件を変える