検索結果

Kernel.#throw(tag, value = nil) -> () (40.0)

• 3.1

• モジュール関数

Kernel.#catchとの組み合わせで大域脱出を行います。 throw は同じ tag を指定した catch のブロックの終わりまでジャンプします。

Kernel.#catchとの組み合わせで大域脱出を行います。 throw
は同じ tag を指定した catch のブロックの終わりまでジャンプします。

throw は探索時に呼び出しスタックをさかのぼるので、
ジャンプ先は同じメソッド内にあるとは限りません。
もし ensure節 が存在するならジャンプ前に実行します。

同じ tag で待っている catch が存在しない場合は、例外で
スレッドが終了します。

同じ tag であるとは Object#object_id が同じであるという意味です。

@param tag catch の引数に対応する任意のオブジェクトです。
@pa...

• Kernel

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

• 3.1

• モジュール関数

グローバル変数 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] (40.0)

• 3.1

• モジュール関数

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

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

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

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

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

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

• Kernel
• Proc
• Symbol

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

• 3.1

• モジュール関数

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

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

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

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

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

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

• Kernel
• Proc
• Symbol

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

• 3.1

• モジュール関数

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

• 3.1

• モジュール関数

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.#untrace_var(varname, hook = nil) -> [String|Proc] (40.0)

• 3.1

• モジュール関数

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

Marshal.#load(port, proc = nil) -> object (40.0)

• 3.1

• モジュール関数

port からマーシャルデータを読み込んで、元のオブジェクトと同 じ状態をもつオブジェクトを生成します。

port からマーシャルデータを読み込んで、元のオブジェクトと同
じ状態をもつオブジェクトを生成します。

proc として手続きオブジェクトが与えられた場合には読み込んだ
オブジェクトを引数にその手続きを呼び出します。

//emlist[例][ruby]{
str = Marshal.dump(["a", 1, 10 ** 10, 1.0, :foo])
p Marshal.load(str, proc {|obj| p obj})

# => "a"
# 1
# 10000000000
# 1.0
# :foo
# ["a", 1, 10000000000...

• IO
• Marshal
• Proc
• String

Marshal.#restore(port, proc = nil) -> object (40.0)

• 3.1

• モジュール関数

port からマーシャルデータを読み込んで、元のオブジェクトと同 じ状態をもつオブジェクトを生成します。

port からマーシャルデータを読み込んで、元のオブジェクトと同
じ状態をもつオブジェクトを生成します。

proc として手続きオブジェクトが与えられた場合には読み込んだ
オブジェクトを引数にその手続きを呼び出します。

//emlist[例][ruby]{
str = Marshal.dump(["a", 1, 10 ** 10, 1.0, :foo])
p Marshal.load(str, proc {|obj| p obj})

# => "a"
# 1
# 10000000000
# 1.0
# :foo
# ["a", 1, 10000000000...

• IO
• Marshal
• Proc
• String

Math.#atan2(y, x) -> Float (40.0)

• 3.1

• モジュール関数

y / x の逆正接関数（arctangent）の値をラジアンで返します。

y / x の逆正接関数（arctangent）の値をラジアンで返します。

@param y 実数
@param x 実数

@return 返される値の範囲は [-π, π] です。


//emlist[例][ruby]{
Math.atan2(1,0) #=> 1.5707963267949
Math.atan2(-1,0) #=> -1.5707963267949
//}

@raise TypeError y, x に数値以外を指定した場合に発生します。

@raise RangeError y, x に実数以外の数値を指定した場合に発生します。

@see Math.#...

• Math

絞り込み条件を変える

Math.#hypot(x, y) -> Float (40.0)

• 3.1

• モジュール関数

sqrt(x*x + y*y) を返します。

sqrt(x*x + y*y) を返します。

この値は x, y を直交する 2 辺とする直角三角形の斜辺（hypotenuse）の長さです。

@param x 実数
@param y 実数

@raise TypeError 引数のどちらかに数値以外を指定した場合に発生します。

@raise RangeError 引数のどちらかに実数以外の数値を指定した場合に発生します。

//emlist[例][ruby]{
Math.hypot(3, 4) #=> 5.0
//}

• Math

Math.#ldexp(x, exp) -> Float (40.0)

• 3.1

• モジュール関数

実数 x に 2 の exp 乗をかけた数を返します。

実数 x に 2 の exp 乗をかけた数を返します。

@param x 実数
@param exp 整数。小数点以下切捨て。

@raise TypeError 引数のどちらかに数値以外を指定した場合に発生します。

@raise RangeError 引数のどちらかに実数以外の数値を指定した場合に発生します。

//emlist[例][ruby]{
fraction, exponent = Math.frexp(1234)
Math.ldexp(fraction, exponent) # => 1234.0
//}

• Math

Math.#log(x) -> Float (40.0)

• 3.1

• モジュール関数

x の対数（logarithm）を返します。

x の対数（logarithm）を返します。

引数 x, b の両方に 0 を指定した場合は Float::NAN を返します。

@param x 正の実数を指定します。

@param b 底を指定します。省略した場合は自然対数（natural logarithm）を計算します。

@raise TypeError 引数のどちらかに数値以外を指定した場合に発生します。

@raise RangeError 引数のどちらかに実数以外の数値を指定した場合に発生します。

@raise DomainError 引数のどちらかに負の数を指定した場合に発生します。

//emlist[例][ru...

• Math

Math.#log(x, b) -> Float (40.0)

• 3.1

• モジュール関数

x の対数（logarithm）を返します。

x の対数（logarithm）を返します。

引数 x, b の両方に 0 を指定した場合は Float::NAN を返します。

@param x 正の実数を指定します。

@param b 底を指定します。省略した場合は自然対数（natural logarithm）を計算します。

@raise TypeError 引数のどちらかに数値以外を指定した場合に発生します。

@raise RangeError 引数のどちらかに実数以外の数値を指定した場合に発生します。

@raise DomainError 引数のどちらかに負の数を指定した場合に発生します。

//emlist[例][ru...

• Math

NKF.#nkf(opt, str) -> String (40.0)

• 3.1

• モジュール関数

文字列 str の文字コードを変換し、変換結果の文字列を返します。

文字列 str の文字コードを変換し、変換結果の文字列を返します。

opt には、nkf と同じコマンドラインオプションを指定します。
オプション文字列は NKF のオプション文字列の項を
見てください。
オプションを複数指定する場合は、NKF.nkf('-Se', str) や
NKF.nkf('-S -e', str) などとします。optは、必ず '-'
で始めなければいけないことに注意してください。

@param opt オプション文字列です。
@param str 変換対象の文字列です。

=== 注意

このメソッドは(nkf コマンドがそうであるように)、MIME Base...

• NKF

絞り込み条件を変える

Newton.#nlsolve(f, x) -> Integer (40.0)

• 3.1

• モジュール関数

ニュートン法を用いて非線形方程式 f(x) = 0 の解 x を求めます。

ニュートン法を用いて非線形方程式 f(x) = 0 の解 x を求めます。

@param f 関数を表すオブジェクトを指定します。詳細は
bigdecimal/newton をご覧ください。

@param x 探索を開始する点を数値の配列で指定します。解が複数ある場合、初
期値によって得られる解が異なります。また，初期値によっては収束
せずに RuntimeError が発生する場合があります。実行後は引
数 x に指定したオブジェクトに解が代入されます。
実行後は解を表す値が代入されています。

...

• Newton

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

• 3.1

• モジュール関数

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

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

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

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

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

• ObjectSpace
• Proc
• spec/rubycmd
• tempfile

ObjectSpace.#define_finalizer(obj, proc) -> Array (40.0)

• 3.1

• モジュール関数

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

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

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

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

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

• ObjectSpace
• Proc
• spec/rubycmd
• tempfile

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

• 3.1

• モジュール関数

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

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

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

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

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

• ObjectSpace

OpenSSL::Random.#egd_bytes(filename, length) -> true (40.0)

• 3.1

• モジュール関数

EGD(Entropy Gathering Daemon) から length バイト分のエントロピーを得ます。

EGD(Entropy Gathering Daemon) から length バイト分のエントロピーを得ます。

filename で指定した Unix domain socket から EGD に問い合わせ、
指定した大きさのエントロピーを乱数生成器に追加します。

@param filename EGD のソケットのファイル名
@param length 読み込むバイト数
@raise OpenSSL::Random::RandomError


@raise OpenSSL::Random::RandomError

• OpenSSL::Random

絞り込み条件を変える

OpenSSL::Random.#random_add(str, entropy) -> self (40.0)

• 3.1

• モジュール関数

乱数生成器にエントロピーを追加します。

乱数生成器にエントロピーを追加します。

entropy には str が持っているエントロピーの予測値(の下限)を
バイト単位で渡します。

@param str 予測不可能な内容の文字列
@param entropy str が持っているエントロピーの予測値(バイト単位)の浮動小数点数

• OpenSSL::Random

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

• 3.1

• モジュール関数

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

Process.#daemon(nochdir = nil, noclose = nil) -> 0 (40.0)

• 3.1

• モジュール関数

プロセスから制御端末を切り離し、 バックグラウンドにまわってデーモンとして動作させます。

プロセスから制御端末を切り離し、
バックグラウンドにまわってデーモンとして動作させます。

カレントディレクトリを / に移動します。
ただし nochdir に真を指定したときにはこの動作は抑制され、
カレントディレクトリは移動しません。

標準入力・標準出力・標準エラー出力を /dev/null にリダイレクトします。
ただし noclose に真を指定したときにはこの動作は抑制され、
リダイレクトは行なわれません。


@param nochdir true を指定した場合、カレントディレクトリを移動しません。

@param noclose true を指定した場合、標準入力・標準出...

• Process

Process.#getpriority(which, who) -> Integer (40.0)

• 3.1

• モジュール関数

which に従いプロセス、プロセスグループ、ユーザのいずれかの現在のプライオリティを整数で返します。

which に従いプロセス、プロセスグループ、ユーザのいずれかの現在のプライオリティを整数で返します。

@param which プライオリティの種類を次の定数で指定します。 Process::PRIO_PROCESS,
Process::PRIO_PGRP, Process::PRIO_USER。

@param who which の値にしたがってプロセス ID、プロセスグループ ID、ユーザ ID のいずれかを整数で指定します。

@raise Errno::EXXX プライオリティの取得に失敗した場合に発生します。

@raise NotImplement...

• Process

Process.#initgroups(user, group) -> [Integer] (40.0)

• 3.1

• モジュール関数

user が属するグループのリストを更新し、group をそのリストに加えます。

user が属するグループのリストを更新し、group をそのリストに加えます。

このメソッドを呼ぶには root 権限が必要です。

@param user ユーザ名を表す文字列で指定します。

@param group ユーザグループ ID を整数で指定します。

@raise NotImplementedError メソッドが現在のプラットフォームで実装されていない場合に発生します。

• Process

絞り込み条件を変える

Process.#setpgid(pid, pgrp) -> 0 (40.0)

• 3.1

• モジュール関数

プロセス ID が pid であるプロセスのプロセスグループを pgrp に設定します。

プロセス ID が pid であるプロセスのプロセスグループを pgrp に設定します。

@param pid プロセス ID を整数で指定します。pid が 0 の時はカレントプロセスの ID を指定したのと同じです。
プロセスグループの設定に成功した場合は 0 を返します。

@param pgrp プロセスグループ ID を整数で指定します。pgrp が 0 の時は pid を指定したのと同じです。

@raise Errno::EXXX プロセスグループの設定に失敗した場合に発生します。

@raise NotImplementedError メソッドが現在の...

• Process

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

• 3.1

• モジュール関数

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

• 3.1

• モジュール関数

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

• 3.1

• モジュール関数

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

• 3.1

• モジュール関数

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::Sys.#setregid(rid, eid) -> nil (40.0)

• 3.1

• モジュール関数

システムコールの setregid(2) を呼びます。

システムコールの setregid(2) を呼びます。

@param rid システムコールの引数を整数で指定します。

@param eid システムコールの引数を整数で指定します。

@raise NotImplementedError システムコールが現在のプラットフォームで提供されていない場合に発生します。

@raise Errno::EXXX システムコールに失敗した場合に発生します。

• Process::Sys

Process::Sys.#setreuid(rid, eid) -> nil (40.0)

• 3.1

• モジュール関数

システムコールの setreuid(2) を呼びます。

システムコールの setreuid(2) を呼びます。

@param rid システムコールの引数を整数で指定します。

@param eid システムコールの引数を整数で指定します。

@raise NotImplementedError システムコールが現在のプラットフォームで提供されていない場合に発生します。

@raise Errno::EXXX システムコールに失敗した場合に発生します。

• Process::Sys

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

• 3.1

• モジュール関数

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

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

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

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

• Readline

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

• 3.1

• モジュール関数

指定された割り込み 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 (40.0)

• 3.1

• モジュール関数

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

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

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

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

絞り込み条件を変える

Syslog.#alert(message, *arg) -> self (40.0)

• 3.1

• モジュール関数

Syslog#log()のショートカットメソッド。 システムによっては定義されていないものもあります。

Syslog#log()のショートカットメソッド。
システムによっては定義されていないものもあります。

例えば、Syslog.emerg(message, *arg) は、Syslog.log(Syslog::LOG_EMERG, message, *arg)
と同じです。

@param message フォーマット文字列です。Kernel.#sprintf と同じ形式の引数を指定します。

@param arg フォーマットされる引数です。

@raise ArgumentError 引数が1つ以上でない場合に発生します。

@raise RuntimeError syslog がop...

• Syslog

Syslog.#crit(message, *arg) -> self (40.0)

• 3.1

• モジュール関数

Syslog#log()のショートカットメソッド。 システムによっては定義されていないものもあります。

Syslog#log()のショートカットメソッド。
システムによっては定義されていないものもあります。

例えば、Syslog.emerg(message, *arg) は、Syslog.log(Syslog::LOG_EMERG, message, *arg)
と同じです。

@param message フォーマット文字列です。Kernel.#sprintf と同じ形式の引数を指定します。

@param arg フォーマットされる引数です。

@raise ArgumentError 引数が1つ以上でない場合に発生します。

@raise RuntimeError syslog がop...

• Syslog

Syslog.#debug(message, *arg) -> self (40.0)

• 3.1

• モジュール関数

Syslog#log()のショートカットメソッド。 システムによっては定義されていないものもあります。

Syslog#log()のショートカットメソッド。
システムによっては定義されていないものもあります。

例えば、Syslog.emerg(message, *arg) は、Syslog.log(Syslog::LOG_EMERG, message, *arg)
と同じです。

@param message フォーマット文字列です。Kernel.#sprintf と同じ形式の引数を指定します。

@param arg フォーマットされる引数です。

@raise ArgumentError 引数が1つ以上でない場合に発生します。

@raise RuntimeError syslog がop...

• Syslog

Syslog.#emerg(message, *arg) -> self (40.0)

• 3.1

• モジュール関数

Syslog#log()のショートカットメソッド。 システムによっては定義されていないものもあります。

Syslog#log()のショートカットメソッド。
システムによっては定義されていないものもあります。

例えば、Syslog.emerg(message, *arg) は、Syslog.log(Syslog::LOG_EMERG, message, *arg)
と同じです。

@param message フォーマット文字列です。Kernel.#sprintf と同じ形式の引数を指定します。

@param arg フォーマットされる引数です。

@raise ArgumentError 引数が1つ以上でない場合に発生します。

@raise RuntimeError syslog がop...

• Syslog

Syslog.#err(message, *arg) -> self (40.0)

• 3.1

• モジュール関数

Syslog#log()のショートカットメソッド。 システムによっては定義されていないものもあります。

Syslog#log()のショートカットメソッド。
システムによっては定義されていないものもあります。

例えば、Syslog.emerg(message, *arg) は、Syslog.log(Syslog::LOG_EMERG, message, *arg)
と同じです。

@param message フォーマット文字列です。Kernel.#sprintf と同じ形式の引数を指定します。

@param arg フォーマットされる引数です。

@raise ArgumentError 引数が1つ以上でない場合に発生します。

@raise RuntimeError syslog がop...

• Syslog

絞り込み条件を変える

Syslog.#info(message, *arg) -> self (40.0)

• 3.1

• モジュール関数

Syslog#log()のショートカットメソッド。 システムによっては定義されていないものもあります。

Syslog#log()のショートカットメソッド。
システムによっては定義されていないものもあります。

例えば、Syslog.emerg(message, *arg) は、Syslog.log(Syslog::LOG_EMERG, message, *arg)
と同じです。

@param message フォーマット文字列です。Kernel.#sprintf と同じ形式の引数を指定します。

@param arg フォーマットされる引数です。

@raise ArgumentError 引数が1つ以上でない場合に発生します。

@raise RuntimeError syslog がop...

• Syslog

Syslog.#notice(message, *arg) -> self (40.0)

• 3.1

• モジュール関数

Syslog#log()のショートカットメソッド。 システムによっては定義されていないものもあります。

Syslog#log()のショートカットメソッド。
システムによっては定義されていないものもあります。

例えば、Syslog.emerg(message, *arg) は、Syslog.log(Syslog::LOG_EMERG, message, *arg)
と同じです。

@param message フォーマット文字列です。Kernel.#sprintf と同じ形式の引数を指定します。

@param arg フォーマットされる引数です。

@raise ArgumentError 引数が1つ以上でない場合に発生します。

@raise RuntimeError syslog がop...

• Syslog

Syslog.#warning(message, *arg) -> self (40.0)

• 3.1

• モジュール関数

Syslog#log()のショートカットメソッド。 システムによっては定義されていないものもあります。

Syslog#log()のショートカットメソッド。
システムによっては定義されていないものもあります。

例えば、Syslog.emerg(message, *arg) は、Syslog.log(Syslog::LOG_EMERG, message, *arg)
と同じです。

@param message フォーマット文字列です。Kernel.#sprintf と同じ形式の引数を指定します。

@param arg フォーマットされる引数です。

@raise ArgumentError 引数が1つ以上でない場合に発生します。

@raise RuntimeError syslog がop...

• Syslog

WEBrick::HTTPUtils.#mime_type(filename, mime_tab) -> String (40.0)

• 3.1

• モジュール関数

ファイル名 filename の拡張子をもとにその MIME タイプを指定された mime_tab から探して文字列として返します。MIME タイプが見つからない場合は "application/octet-stream" を返します。

ファイル名 filename の拡張子をもとにその MIME タイプを指定された mime_tab
から探して文字列として返します。MIME タイプが見つからない場合は "application/octet-stream"
を返します。

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

@param mime_tab 拡張子をキー、MIME タイプを値とするハッシュを指定します。

require 'webrick'
include WEBrick::HTTPUtils
p mime_type('index.html', DefaultMimeTypes) ...

• WEBrick::HTTPUtils

Zlib.#deflate(string, level = Zlib::DEFAULT_COMPRESSION) -> String (40.0)

• 3.1

• モジュール関数

引数 string を圧縮します。Zlib::Deflate.deflate と同じです。

引数 string を圧縮します。Zlib::Deflate.deflate と同じです。

@param string 圧縮する文字列を指定します。
@param level 圧縮の水準を詳細に指定します。
有効な値は Zlib::NO_COMPRESSION,
Zlib::BEST_SPEED, Zlib::BEST_COMPRESSION,
Zlib::DEFAULT_COMPRESSION 及び 0 から 9 の整数です。

@see Zlib::Deflate.deflate

• Zlib

絞り込み条件を変える

Base64.#decode64(str) -> String (22.0)

• 3.1

• モジュール関数

与えられた文字列を Base64 デコードしたデータを返します。

与えられた文字列を Base64 デコードしたデータを返します。

このメソッドは 2045 に対応しています。

@param str Base64 デコードする文字列を指定します。

require 'base64'
str = 'VGhpcyBpcyBsaW5lIG9uZQpUaGlzIG' +
'lzIGxpbmUgdHdvClRoaXMgaXMgbGlu' +
'ZSB0aHJlZQpBbmQgc28gb24uLi4K'
puts Base64.decode64(str)

# This is line one
# T...

• Base64

Base64.#encode64(bin) -> String (22.0)

• 3.1

• モジュール関数

与えられたデータを Base64 エンコードした文字列を返します。

与えられたデータを Base64 エンコードした文字列を返します。

このメソッドは 2045 に対応しています。
エンコード後の文字で 60 文字ごとに改行を追加します。

@param bin Base64 エンコードするデータを指定します。


require 'base64'
Base64.encode64("Now is the time for all good coders\nto learn Ruby")

# => Tm93IGlzIHRoZSB0aW1lIGZvciBhbGwgZ29vZCBjb2RlcnMKdG8gbGVhcm4g
# ...

• Base64

Base64.#strict_decode64(str) -> String (22.0)

• 3.1

• モジュール関数

与えられた文字列を Base64 デコードしたデータを返します。

与えられた文字列を Base64 デコードしたデータを返します。

このメソッドは 4648 に対応しています。


@param str Base64 デコードする文字列を指定します。

@raise ArgumentError 与えられた引数が Base64 エンコードされたデータとして正しい形式ではない場合に発生します。
例えば、アルファベットでない文字列や CR, LF などが含まれている場合にこの例外は発生します。

• Base64

Base64.#strict_encode64(bin) -> String (22.0)

• 3.1

• モジュール関数

与えられたデータを Base64 エンコードした文字列を返します。

与えられたデータを Base64 エンコードした文字列を返します。

このメソッドは 4648 に対応しています。
改行コードを追加することはありません。

@param bin Base64 エンコードするデータを指定します。

• Base64

Base64.#urlsafe_decode64(str) -> String (22.0)

• 3.1

• モジュール関数

与えられた文字列を Base64 デコードしたデータを返します。

与えられた文字列を Base64 デコードしたデータを返します。

このメソッドは 4648 の "Base 64 Encoding with URL and Filename Safe Alphabet" に対応しています。
"+" を "-" に "/" を "_" に置き換えます。

@param str Base64 デコードする文字列を指定します。

@raise ArgumentError 与えられた引数が Base64 エンコードされたデータとして正しい形式ではない場合に発生します。
例えば、アルファベットでない文字列や CR, LF などが含まれている場合にこの例...

• Base64

絞り込み条件を変える

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

• 3.1

• モジュール関数

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

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

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

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

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

• Benchmark
• Benchmark::Job

BigMath.#E(prec) -> BigDecimal (22.0)

• 3.1

• モジュール関数

自然対数の底 e を prec で指定した精度で計算します。

自然対数の底 e を prec で指定した精度で計算します。

@param prec 計算結果の精度。

@raise ArgumentError prec に 0 以下が指定された場合に発生します。

//emlist[][ruby]{
require "bigdecimal/math"

puts BigMath::E(2) #=> 0.27e1
puts BigMath::E(4) #=> 0.2718e1
puts BigMath::E(10) #=> 0.2718281828e1
//}

• BigMath

BigMath.#PI(prec) -> BigDecimal (22.0)

• 3.1

• モジュール関数

円周率を prec で指定した精度で計算します。

円周率を prec で指定した精度で計算します。

@param prec 計算結果の精度。

@raise ArgumentError prec に 0 以下が指定された場合に発生します。

//emlist[][ruby]{
require "bigdecimal/math"

puts BigMath::PI(2) #=> 0.31415926535897932384671233672993238432e1
puts BigMath::PI(5) #=> 0.31415926535897932384627534923029509162e1
puts BigMath::PI(10) ...

• BigMath

DRb::DRbProtocol.#add_protocol(prot) -> () (22.0)

• 3.1

• モジュール関数

新たなプロトコルを DRbProtocol モジュールに登録します。

新たなプロトコルを DRbProtocol モジュールに登録します。

@param prot プロトコル定義クラス

• DRb::DRbProtocol

Digest.#bubblebabble(string) -> String (22.0)

• 3.1

• モジュール関数

与えられた文字列を BubbleBabble エンコードした文字列を返します。

与えられた文字列を BubbleBabble エンコードした文字列を返します。

@param string 文字列を指定します。

• Digest

絞り込み条件を変える

Digest.#hexencode(string) -> String (22.0)

• 3.1

• モジュール関数

引数である文字列 string を、16進数に変換した文字列を生成して返します。

引数である文字列 string を、16進数に変換した文字列を生成して返します。

@param string 文字列を指定します。

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

p Digest.hexencode("") # => ""
p Digest.hexencode("d") # => "64"
p Digest.hexencode("\1\2") # => "0102"
p Digest.hexencode("\xB0") # => "b0"

p digest = Digest::MD5.digest("ruby") # => "...

• Digest

ERB::Util.#h(s) -> String (22.0)

• 3.1

• モジュール関数

文字列 s を HTML用にエスケープした文字列を返します。

文字列 s を HTML用にエスケープした文字列を返します。

文字列 s 中に含まれる &"<> を、実体参照 &amp; &quot; &lt; &gt; にそれぞれ変更した文字列を返します
(CGI.escapeHTMLとほぼ同じです)。

@param s HTMLエスケープを行う文字列

//emlist[例][ruby]{
require "erb"
include ERB::Util

puts html_escape("is a > 0 & a < 10?")
# is a &gt; 0 &amp; a &lt; 10?
//}

• ERB::Util

ERB::Util.#html_escape(s) -> String (22.0)

• 3.1

• モジュール関数

文字列 s を HTML用にエスケープした文字列を返します。

文字列 s を HTML用にエスケープした文字列を返します。

文字列 s 中に含まれる &"<> を、実体参照 &amp; &quot; &lt; &gt; にそれぞれ変更した文字列を返します
(CGI.escapeHTMLとほぼ同じです)。

@param s HTMLエスケープを行う文字列

//emlist[例][ruby]{
require "erb"
include ERB::Util

puts html_escape("is a > 0 & a < 10?")
# is a &gt; 0 &amp; a &lt; 10?
//}

• ERB::Util

ERB::Util.#u(s) -> String (22.0)

• 3.1

• モジュール関数

文字列 s を URLエンコードした文字列を返します。

文字列 s を URLエンコードした文字列を返します。

文字列 s 中に含まれる 2バイト文字や半角スペースについて URL エンコードを行った文字列を返します(CGI.escapeとほぼ同じです)。

@param s URLエンコードを行う文字列

//emlist[例][ruby]{
require "erb"
include ERB::Util

puts url_encode("Programming Ruby: The Pragmatic Programmer's Guide")
# Programming%20Ruby%3A%20%20The%20Pragmatic%20P...

• ERB::Util

ERB::Util.#url_encode(s) -> String (22.0)

• 3.1

• モジュール関数

文字列 s を URLエンコードした文字列を返します。

文字列 s を URLエンコードした文字列を返します。

文字列 s 中に含まれる 2バイト文字や半角スペースについて URL エンコードを行った文字列を返します(CGI.escapeとほぼ同じです)。

@param s URLエンコードを行う文字列

//emlist[例][ruby]{
require "erb"
include ERB::Util

puts url_encode("Programming Ruby: The Pragmatic Programmer's Guide")
# Programming%20Ruby%3A%20%20The%20Pragmatic%20P...

• ERB::Util

絞り込み条件を変える

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

• 3.1

• モジュール関数

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.#getgrgid(gid) -> Etc::Group (22.0)

• 3.1

• モジュール関数

group データベースを検索し、グループ ID が gid であるグループエントリを返します。

group データベースを検索し、グループ ID が gid
であるグループエントリを返します。

@param gid 検索する gid

@raise ArgumentError エントリが見つからなかった場合に発生します。

@see getgrgid(3), Etc::Group

• Etc
• Etc::Group

Etc.#getgrnam(name) -> Etc::Group (22.0)

• 3.1

• モジュール関数

name という名前のグループエントリを返します。

name という名前のグループエントリを返します。

@param name 検索するグループ名。

@raise ArgumentError エントリが見つからなかった場合に発生します。

@see getgrnam(3), Etc::Group

• Etc
• Etc::Group

Etc.#getpwnam(name) -> Etc::Passwd (22.0)

• 3.1

• モジュール関数

passwd データベースを検索し、 名前が name である passwd エントリを返します。

passwd データベースを検索し、
名前が name である passwd エントリを返します。

@param name 検索するユーザ名。

@raise ArgumentError エントリが見つからなかった場合に発生します。

@see getpwnam(3), Etc::Passwd

• Etc
• Etc::Passwd

Etc.#getpwuid(uid = getuid) -> Etc::Passwd (22.0)

• 3.1

• モジュール関数

passwd データベースを検索し、 ユーザ ID が uid である passwd エントリを返します。

passwd データベースを検索し、
ユーザ ID が uid である passwd エントリを返します。

@param uid 検索する uid 。引数を省略した場合には getuid(2) の値を用います。

@raise ArgumentError エントリが見つからなかった場合に発生します。

@see getpwuid(3), Etc::Passwd

• Etc
• Etc::Passwd

絞り込み条件を変える

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

• 3.1

• モジュール関数

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

Fiddle.#dlopen(lib) -> Fiddle::Handle (22.0)

• 3.1

• モジュール関数

ダイナミックライブラリ lib をロードし、 Fiddle::Handle として返します。

ダイナミックライブラリ lib をロードし、
Fiddle::Handle として返します。

Fiddle::Handle.new(lib) と等価です。

@param lib ロードしたいライブラリを文字列で与えます。

@raise Fiddle::DLError dlopen(3) に失敗した時に発生します。

• Fiddle
• Fiddle::Handle

Fiddle.#dlunwrap(addr) -> object (22.0)

• 3.1

• モジュール関数

指定されたアドレスの Ruby オブジェクトを返します。

指定されたアドレスの Ruby オブジェクトを返します。

@param addr Fiddle.#dlwrap が返した Ruby オブジェクトのアドレス(整数)を指定します。

例:

require 'fiddle'
s = 'abc'
p addr = Fiddle.dlwrap(s) #=> 136122440
p Fiddle.dlunwrap(addr) #=> "abc"

• Fiddle

Fiddle.#dlwrap(obj) -> Integer (22.0)

• 3.1

• モジュール関数

指定されたオブジェクト obj のアドレスを表す整数を返します。

指定されたオブジェクト obj のアドレスを表す整数を返します。

@param obj Ruby のオブジェクトを指定します。

例:

require 'fiddle'
s = 'abc'
p addr = Fiddle.dlwrap(s) #=> 136122440
p Fiddle.dlunwrap(addr) #=> "abc"

• Fiddle

Fiddle.#free(addr) -> nil (22.0)

• 3.1

• モジュール関数

指定された addr が指すメモリ領域を開放します。

指定された addr が指すメモリ領域を開放します。

必ず Fiddle.#malloc が返した整数を addr に与えなければいけません。
そうでない場合、ruby インタプリタが異常終了します。

@param addr Fiddle.#malloc で確保されたメモリ領域を指す整数を指定します。

例:
require 'fiddle'
addr = Fiddle.malloc(10)
p addr #=> 136942800
Fiddle.free(addr)

• Fiddle

絞り込み条件を変える

Fiddle.#malloc(size) -> Integer (22.0)

• 3.1

• モジュール関数

size バイトのメモリ領域を確保し、その領域を指す整数を返します。

size バイトのメモリ領域を確保し、その領域を指す整数を返します。

メモリを確保できなかった場合、例外 NoMemoryError が発生するか、あるいは ruby インタプリタが強制終了します。

@param size 必要なメモリ領域のサイズを整数で指定します。

• Fiddle

FileTest.#blockdev?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルがブロックスペシャルファイルである時に真を返します。 そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルがブロックスペシャルファイルである時に真を返します。
そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

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

例:
Dir.glob("/dev/*") { |file|
puts file if FileTest.blockdev?(file)
}
# /dev/disk0
# /dev/di...

• FileTest

FileTest.#chardev?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルがキャラクタスペシャルファイルの時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルがキャラクタスペシャルファイルの時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

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

例:
Dir.glob("/dev/*") { |file|
puts file if FileTest.chardev?(file)
}
# /dev/console
# /dev/tty...

• FileTest

FileTest.#directory?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルがディレクトリの時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルがディレクトリの時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

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

例:
FileTest.directory?('/etc') # => true
FileTest.directory?('/etc/passwd') # => false

f = File.open('/etc')...

• FileTest

FileTest.#empty?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルが存在して、そのサイズが 0 である時に真を返します。 そうでない場合、あるいはシステムコールに失敗した場合には false を返します。

ファイルが存在して、そのサイズが 0 である時に真を返します。
そうでない場合、あるいはシステムコールに失敗した場合には false を返します。

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

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

//emlist[例:][ruby]{
IO.write("zero.txt", "")
FileTest.zero?("zero.txt") # => true
IO.write("nonzero.txt", "1")
Fil...

• FileTest

絞り込み条件を変える

FileTest.#executable?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルがカレントプロセスにより実行できる時に真を返しま す。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルがカレントプロセスにより実行できる時に真を返しま
す。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

例:
FileTest.executable?('/bin') # => true
FileTest.executable?('/bin/bash') # => true

• FileTest

FileTest.#executable_real?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルがカレントプロセスの実ユーザか実グループで実行できる時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルがカレントプロセスの実ユーザか実グループで実行できる時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

//emlist[例][ruby]{
IO.write("empty.txt", "")
File.chmod(0744, "empty.txt")
FileTest.executable_real?("empty.txt") # => true
File.chmod(0644, "empty.txt")
FileTest.ex...

• FileTest

FileTest.#exist?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルが存在する時に真を返します。そうでない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルが存在する時に真を返します。そうでない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

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

例:
FileTest.exist?('/etc/passwd') # => true
FileTest.exist?('/etc') # => true
FileTest.exist?('/etc/no_such_file') # => false...

• FileTest

FileTest.#file?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルが通常ファイルである時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルが通常ファイルである時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

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

例:
FileTest.file?('/bin/bash') # => true
FileTest.file?('/bin') # => false
FileTest.file?('/no_such_file') ...

• FileTest

FileTest.#grpowned?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルのグループ ID がカレントプロセスの実効グループ ID と等しい時に真を返 します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルのグループ ID がカレントプロセスの実効グループ ID と等しい時に真を返
します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

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

//emlist[例][ruby]{
IO.write("testfile", "")
File.chown(-1, Process.gid, "testfile")
FileT...

• FileTest

絞り込み条件を変える

FileTest.#owned?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルのユーザがカレントプロセスの実効ユーザと等しい時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルのユーザがカレントプロセスの実効ユーザと等しい時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

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

//emlist[例][ruby]{
IO.write("testfile", "")
File.chown(Process.uid, -1, "testfile")
FileTest.owned?(...

• FileTest

FileTest.#pipe?(file) -> bool (22.0)

• 3.1

• モジュール関数

指定したファイルがパイプである時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

指定したファイルがパイプである時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

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

例:
r, w = IO.pipe
FileTest.pipe?(r) # => true
FileTest.pipe?(w) # => true

• FileTest

FileTest.#readable?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルがカレントプロセスにより読み込み可能な時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルがカレントプロセスにより読み込み可能な時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

//emlist[例][ruby]{
IO.write("testfile", "")
File.chmod(0644, "testfile")
FileTest.readable?("testfile") # => true
File.chmod(0200, "testfile")
FileTest.readable?("testfile"...

• FileTest

FileTest.#readable_real?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルがカレントプロセスの実ユーザか実グループによって読み込み可能な時に真を 返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルがカレントプロセスの実ユーザか実グループによって読み込み可能な時に真を
返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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


@see FileTest.#readable?

• FileTest

FileTest.#setgid?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルが setgid(2) されている時に真を返 します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルが setgid(2) されている時に真を返
します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

//emlist[例][ruby]{
require 'fileutils'
IO.write("testfile", "")
FileUtils.chmod("g+s", "testfile")
FileTest.setgid?("testfile") # => true
FileUtils.chmod("g-s", "...

• FileTest

絞り込み条件を変える

FileTest.#setuid?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルが setuid(2) されている時に真を返 します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルが setuid(2) されている時に真を返
します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

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

//emlist[例][ruby]{
require 'fileutils'
IO.write("testfile", "")
FileUtils.chmod("u+s", "testfile")
FileTe...

• FileTest

FileTest.#size(file) -> Integer (22.0)

• 3.1

• モジュール関数

ファイルのサイズを返します。

ファイルのサイズを返します。

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

@raise Errno::EXXX file が存在しない場合、あるいはシステムコールに失敗した場合に発生します。

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

@see FileTest.#size?, FileTest.#zero?

例:
FileTest.size('/etc/passwd') # => 5925

• FileTest

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

• 3.1

• モジュール関数

ファイルのサイズを返します。ファイルが存在しない時や ファイルのサイズが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.#socket?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルがソケットである時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルがソケットである時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

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

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

IO.write("testfile", "test")
p FileTest.socket?("testfile") ...

• FileTest

FileTest.#sticky?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルの sticky ビット(chmod(2) 参照)が 立っている時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルの sticky ビット(chmod(2) 参照)が
立っている時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

//emlist[例][ruby]{
require 'fileutils'
IO.write("testfile", "")
FileUtils.chmod("o+t", "testfile")
FileTest.sticky?("testfile") # => true
FileUtils....

• FileTest

絞り込み条件を変える

FileTest.#symlink?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルがシンボリックリンクである時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルがシンボリックリンクである時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

//emlist[例][ruby]{
IO.write("testfile", "test")
FileTest.symlink?("testfile") # => false
File.symlink("testfile", "testlink")
FileTest.symlink?("testlink") # => true
//}

• FileTest

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

• 3.1

• モジュール関数

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

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

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

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

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

• FileTest

FileTest.#world_writable?(path) -> bool (22.0)

• 3.1

• モジュール関数

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

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

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

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

m = FileTest.world_writable?("/tmp")
"%o" % m #=> "777"

• FileTest

FileTest.#writable?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルがカレントプロセスにより書き込み可能である時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルがカレントプロセスにより書き込み可能である時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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

//emlist[例][ruby]{
IO.write("testfile", "test")
File.chmod(0600, "testfile")
FileTest.writable?("testfile") # => true
File.chmod(0400, "testfile")
FileTest.writable?("tes...

• FileTest

FileTest.#writable_real?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルがカレントプロセスの実ユーザか実グループによって書き込み可能である時に真 を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

ファイルがカレントプロセスの実ユーザか実グループによって書き込み可能である時に真
を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには false を返します。

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


@see FileTest.#writable?

• FileTest

絞り込み条件を変える

FileTest.#zero?(file) -> bool (22.0)

• 3.1

• モジュール関数

ファイルが存在して、そのサイズが 0 である時に真を返します。 そうでない場合、あるいはシステムコールに失敗した場合には false を返します。

ファイルが存在して、そのサイズが 0 である時に真を返します。
そうでない場合、あるいはシステムコールに失敗した場合には false を返します。

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

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

//emlist[例:][ruby]{
IO.write("zero.txt", "")
FileTest.zero?("zero.txt") # => true
IO.write("nonzero.txt", "1")
Fil...

• FileTest

JSON.#fast_generate(object) -> String (22.0)

• 3.1

• モジュール関数

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

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

このメソッドは循環参照のチェックを無効にしています。また、
JSON::NaN, JSON::Infinity, JSON::MinusInfinity を生成することがあります。
このため容易に無限ループを発生させることができるので、気をつけてください。

fast_unparse は将来削除される予定です。

@param object JSON 形式の文字列に変換するオブジェクトを指定します。

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

JSON.fast_generate({ n...

• JSON

JSON.#fast_unparse(object) -> String (22.0)

• 3.1

• モジュール関数

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

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

このメソッドは循環参照のチェックを無効にしています。また、
JSON::NaN, JSON::Infinity, JSON::MinusInfinity を生成することがあります。
このため容易に無限ループを発生させることができるので、気をつけてください。

fast_unparse は将来削除される予定です。

@param object JSON 形式の文字列に変換するオブジェクトを指定します。

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

JSON.fast_generate({ n...

• JSON

Kconv.#guess(str) -> Encoding (22.0)

• 3.1

• モジュール関数

文字列 str のエンコーディングを判定します。戻り値は Kconv の定数です。

文字列 str のエンコーディングを判定します。戻り値は
Kconv の定数です。

このモジュール関数で判定できるのは、
* ISO-2022-JP (Kconv::JIS)
* Shift_JIS (Kconv::SJIS)
* EUC-JP (Kconv::EUC)
* ASCII (Kconv::ASCII)
* UTF-8 (Kconv::UTF8)
* UTF-16BE (Kconv::UTF16)
* 不明 (Kconv::UNKNOWN)
* 以上のどれでもない (Kconv::BINARY)
のいずれかです。

@param str エンコー...

• Kconv

Kconv.#iseuc(str) -> bool (22.0)

• 3.1

• モジュール関数

文字列 str が EUC-JP なバイト列として正当であるかどうかを判定します。

文字列 str が EUC-JP なバイト列として正当であるかどうかを判定します。

@param str 判定対象の文字列
@see String#iseuc

• Kconv

絞り込み条件を変える