検索結果

FileUtils.#makedirs(list, options = {}) -> Array (58.0)

• 3.2

• モジュール関数

ディレクトリ dir とその親ディレクトリを全て作成します。

ディレクトリ dir とその親ディレクトリを全て作成します。

例えば、
//emlist[][ruby]{
require 'fileutils'
FileUtils.mkdir_p('/usr/local/lib/ruby')
//}

は以下の全ディレクトリを (なければ) 作成します。

* /usr
* /usr/local
* /usr/local/bin
* /usr/local/bin/ruby

@param list 作成するディレクトリ。一つの場合は文字列でも指定できます。
二つ以上指定する場合は配列で指定します。

@param...

• FileUtils

FileUtils.#mkdir_p(list, options = {}) -> Array (58.0)

• 3.2

• モジュール関数

ディレクトリ dir とその親ディレクトリを全て作成します。

ディレクトリ dir とその親ディレクトリを全て作成します。

例えば、
//emlist[][ruby]{
require 'fileutils'
FileUtils.mkdir_p('/usr/local/lib/ruby')
//}

は以下の全ディレクトリを (なければ) 作成します。

* /usr
* /usr/local
* /usr/local/bin
* /usr/local/bin/ruby

@param list 作成するディレクトリ。一つの場合は文字列でも指定できます。
二つ以上指定する場合は配列で指定します。

@param...

• FileUtils

FileUtils.#mkpath(list, options = {}) -> Array (58.0)

• 3.2

• モジュール関数

ディレクトリ dir とその親ディレクトリを全て作成します。

ディレクトリ dir とその親ディレクトリを全て作成します。

例えば、
//emlist[][ruby]{
require 'fileutils'
FileUtils.mkdir_p('/usr/local/lib/ruby')
//}

は以下の全ディレクトリを (なければ) 作成します。

* /usr
* /usr/local
* /usr/local/bin
* /usr/local/bin/ruby

@param list 作成するディレクトリ。一つの場合は文字列でも指定できます。
二つ以上指定する場合は配列で指定します。

@param...

• FileUtils

FileUtils.#symlink(src, dest, options = {}) -> () (58.0)

• 3.2

• モジュール関数

src へのシンボリックリンク dest を作成します。

src へのシンボリックリンク dest を作成します。

src が一つの場合、
dest がすでに存在しディレクトリであるときは dest/src を作成します。
dest がすでに存在しディレクトリでないならば例外 Errno::EEXIST が発生します。
ただし :force オプションを指定したときは dest を上書きします。

src が複数の場合、
src[0] へのシンボリックリンク dest/src[0]、src[1] への
シンボリックリンク dest/src[1] …を作成します。
dest がディレクトリでない場合は例外 Errno::ENOTDIR が発生します...

• FileUtils

Kernel.#`(command) -> String (58.0)

• 3.2

• モジュール関数

command を外部コマンドとして実行し、その標準出力を文字列として 返します。このメソッドは `command` の形式で呼ばれます。

command を外部コマンドとして実行し、その標準出力を文字列として
返します。このメソッドは `command` の形式で呼ばれます。

引数 command に対しダブルクォートで囲まれた文字列と同様の解釈と式展開を行った後、
コマンドとして実行します。
コマンドは評価されるたびに実行されます。コマンドの終了ステータスを得るには、$? を参照します。

コマンドの出力を得る必要がなく、単にコマンドを実行したいだけなら
Kernel.#system を使います。特に端末を制御するコマンドでは
`command` は失敗するかもしれません。

d:spec/literal#command ...

• Kernel

絞り込み条件を変える

Kernel.#caller(range) -> [String] | nil (58.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 (58.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 (58.0)

• 3.2

• モジュール関数

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

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

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

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

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

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

@see Kernel.#set_trace_func,K...

• Kernel
• Range

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

• 3.2

• モジュール関数

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

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

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

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

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

• ARGF
• Kernel

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

• 3.2

• モジュール関数

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

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

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

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

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

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

• Kernel

絞り込み条件を変える

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

• 3.2

• モジュール関数

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

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

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

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

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

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

• Kernel

ObjectSpace.#count_objects(result_hash = {}) -> Hash (58.0)

• 3.2

• モジュール関数

オブジェクトを種類ごとにカウントした結果を Hash として返します。

オブジェクトを種類ごとにカウントした結果を Hash として返します。

このメソッドは C Ruby 以外の Ruby では動かないでしょう。

@param result_hash ハッシュを指定します。与えられたハッシュは上書きして返されます。
これを利用すると測定による影響を避けることができます。

@raise TypeError 引数に Hash 以外を与えた場合、発生します。

//emlist[例][ruby]{
ObjectSpace.count_objects # => {:TOTAL=>10000, :FREE=>3011, :T_...

• Hash
• ObjectSpace

ObjectSpace.#define_finalizer(obj) {|id| ...} -> Array (58.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.#define_finalizer(obj, proc) -> Array (58.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.#each_object -> Enumerator (58.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 {|object| ...} -> Integer (58.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 (58.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 (58.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.#memsize_of_all(klass = nil) -> Integer (58.0)

• 3.2

• モジュール関数

すべての生存しているオブジェクトが消費しているメモリ使用量をバイト単位 で返します。

すべての生存しているオブジェクトが消費しているメモリ使用量をバイト単位
で返します。

@param klass 指定したクラスのインスタンスのメモリ使用量を返します。省略
した場合はすべてのクラスのインスタンスのメモリ使用量を返し
ます。

本メソッドは以下のような Ruby のコードで定義できます。

//emlist[例][ruby]{
def memsize_of_all klass = false
total = 0
ObjectSpace.each_object{|e|
total += ObjectSpace....

• ObjectSpace

JSON.#load(source, proc = nil, options = {}) -> object (52.0)

• 3.2

• モジュール関数

与えられた JSON 形式の文字列を Ruby オブジェクトとしてロードして返します。

与えられた JSON 形式の文字列を Ruby オブジェクトとしてロードして返します。

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


require 'json'

str=<<JSON
[1,2,3]
JSON

JSON.load(str) # => [1,2,3]
JSON.load(str, proc{|v| p v }) # => [1,2,3]
# 以下が表示される
# 1
# 2
# 3
# [1,2,3]

str=<<JSON
{ "a"...

• JSON
• Proc

絞り込み条件を変える

JSON.#load_file!(filespec, opts = {}) -> object (52.0)

• 3.2

• モジュール関数

filespec で指定した JSON 形式のファイルを Ruby オブジェクトとしてロードして返します。

filespec で指定した JSON 形式のファイルを Ruby オブジェクトとしてロードして返します。

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

@param options オプションをハッシュで指定します。指定可能なオプションは JSON.#parse! と同様です。

@see JSON.#parse!

• JSON

JSON.#load_file(filespec, opts = {}) -> object (52.0)

• 3.2

• モジュール関数

filespec で指定した JSON 形式のファイルを Ruby オブジェクトとしてロードして返します。

filespec で指定した JSON 形式のファイルを Ruby オブジェクトとしてロードして返します。

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

@param options オプションをハッシュで指定します。指定可能なオプションは JSON.#parse と同様です。

@see JSON.#parse

• JSON

JSON.#restore(source, proc = nil, options = {}) -> object (52.0)

• 3.2

• モジュール関数

与えられた JSON 形式の文字列を Ruby オブジェクトとしてロードして返します。

与えられた JSON 形式の文字列を Ruby オブジェクトとしてロードして返します。

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


require 'json'

str=<<JSON
[1,2,3]
JSON

JSON.load(str) # => [1,2,3]
JSON.load(str, proc{|v| p v }) # => [1,2,3]
# 以下が表示される
# 1
# 2
# 3
# [1,2,3]

str=<<JSON
{ "a"...

• JSON
• Proc

OpenSSL::ASN1.#ObjectId(value) -> OpenSSL::ASN1::ObjectId -> OpenSSL::ASN1::ObjectId (52.0)

• 3.2

• モジュール関数

ASN.1 の ObjectId 型の値を表現する Ruby のオブジェクトを 生成します。

ASN.1 の ObjectId 型の値を表現する Ruby のオブジェクトを
生成します。

OpenSSL::ASN1::ObjectId.new と同じです。

@param value ASN.1 オブジェクト識別子を表す文字列
@param tag タグ番号
@param tagging タグ付けの方法(:IMPLICIT もしくは :EXPLICIT)
@param tag_class タグクラス(:UNIVERSAL, :CONTEXT_SPECIFIC, :APPLICATION, :PRIVATE のいずれか)

• OpenSSL::ASN1

OpenSSL::ASN1.#ObjectId(value, tag, tagging, tag_class) -> OpenSSL::ASN1::ObjectId (52.0)

• 3.2

• モジュール関数

ASN.1 の ObjectId 型の値を表現する Ruby のオブジェクトを 生成します。

ASN.1 の ObjectId 型の値を表現する Ruby のオブジェクトを
生成します。

OpenSSL::ASN1::ObjectId.new と同じです。

@param value ASN.1 オブジェクト識別子を表す文字列
@param tag タグ番号
@param tagging タグ付けの方法(:IMPLICIT もしくは :EXPLICIT)
@param tag_class タグクラス(:UNIVERSAL, :CONTEXT_SPECIFIC, :APPLICATION, :PRIVATE のいずれか)

• OpenSSL::ASN1

絞り込み条件を変える

FileUtils.#chown(user, group, list, options = {}) -> Array (40.0)

• 3.2

• モジュール関数

ファイル list の所有ユーザと所有グループを user と group に変更します。

ファイル list の所有ユーザと所有グループを user と group に変更します。

user, group に nil または -1 を渡すとその項目は変更しません。

@param user ユーザー名か uid を指定します。nil/-1 を指定すると変更しません。

@param group グループ名か gid を指定します。nil/-1 を指定すると変更しません。

@param list ファイルのリストを指定します。対象のファイルが一つの場合は文字列でも指定可能です。
二つ以上指定する場合は配列で指定します。

@param options :n...

• FileUtils

FileUtils.#chown_R(user, group, list, options = {}) -> Array (40.0)

• 3.2

• モジュール関数

list 以下のファイルの所有ユーザと所有グループを user と group へ再帰的に変更します。

list 以下のファイルの所有ユーザと所有グループを
user と group へ再帰的に変更します。

user, group に nil または -1 を渡すとその項目は変更しません。

@param user ユーザー名か uid を指定します。nil/-1 を指定すると変更しません。

@param group グループ名か gid を指定します。nil/-1 を指定すると変更しません。

@param list ファイルのリストを指定します。対象のファイルが一つの場合は文字列でも指定可能です。
二つ以上指定する場合は配列で指定します。

@param opti...

• FileUtils

FileUtils.#move(src, dest, options = {}) -> () (40.0)

• 3.2

• モジュール関数

ファイル src を dest に移動します。

ファイル src を dest に移動します。

src が一つの場合、
dest がすでに存在しディレクトリであるときは src を dest/src へ移動します。
dest がすでに存在しディレクトリでないときは src は dest を上書きします。

src が複数の場合、
src[0] を dest/src[0]、src[1] を dest/src[1] へ移動します。
dest がディレクトリでない場合は例外 Errno::ENOTDIR が発生します。

@param src 元のファイル。一つの場合は文字列でも指定可能です。
二つ以上指定する場合は配列...

• FileUtils

FileUtils.#mv(src, dest, options = {}) -> () (40.0)

• 3.2

• モジュール関数

ファイル src を dest に移動します。

ファイル src を dest に移動します。

src が一つの場合、
dest がすでに存在しディレクトリであるときは src を dest/src へ移動します。
dest がすでに存在しディレクトリでないときは src は dest を上書きします。

src が複数の場合、
src[0] を dest/src[0]、src[1] を dest/src[1] へ移動します。
dest がディレクトリでない場合は例外 Errno::ENOTDIR が発生します。

@param src 元のファイル。一つの場合は文字列でも指定可能です。
二つ以上指定する場合は配列...

• FileUtils

FileUtils.#remove_entry(path, force = false) -> () (40.0)

• 3.2

• モジュール関数

ファイル path を削除します。path がディレクトリなら再帰的に削除します。

ファイル path を削除します。path がディレクトリなら再帰的に削除します。

このメソッドにはローカル脆弱性が存在します。
詳しくは FileUtils.#remove_entry_secure の項を参照してください。

@param path 削除するパス。

@param force 真のときは削除中に発生した StandardError を無視します。

//emlist[][ruby]{
require 'fileutils'
FileUtils.remove_entry '/tmp/ruby.tmp.08883'
//}

@see FileUtils.#remove_e...

• FileUtils
• StandardError

絞り込み条件を変える

JSON.#dump(object, io = nil, limit = nil) -> String | IO (40.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.#Complex(r, i = 0, exception: true) -> Complex | nil (40.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 (40.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.#fork -> Integer | nil (40.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 (40.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.#loop -> Enumerator (40.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

Kernel.#loop { ... } -> object | nil (40.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

Kernel.#open(file, mode_enc = "r", perm = 0666) -> IO (40.0)

• 3.2

• モジュール関数

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

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

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

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

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

• File
• File::Constants
• IO
• Kernel

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

• 3.2

• モジュール関数

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

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

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

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

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

• File
• File::Constants
• IO
• Kernel

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

• 3.2

• モジュール関数

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

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

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

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

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

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

@param ...

• Kernel

絞り込み条件を変える

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

• 3.2

• モジュール関数

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

• 3.2

• モジュール関数

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.#readlines(rs = $/) -> [String] (40.0)

• 3.2

• モジュール関数

ARGFを Kernel.#gets(rs) でEOFまで読み込んで、その各行を要素としてもつ配列を返します。 行の区切りは引数 rs で指定した文字列になります。

ARGFを Kernel.#gets(rs) でEOFまで読み込んで、その各行を要素としてもつ配列を返します。
行の区切りは引数 rs で指定した文字列になります。

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

@param rs 行の区切りとなる文字列です。
@raise Errno::EXXX 読み込みに失敗した場合に発生します。

//emlist[main.rb][ruby]{
ARGV << 'b.txt' << 'b.txt'
p readlines #=> ["...

• ARGF
• Kernel

Kernel.#trace_var(varname) {|new_val| .... } -> nil (40.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] (40.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) -> nil (40.0)

• 3.2

• モジュール関数

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

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

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

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

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

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

• Kernel
• Proc
• Symbol

ObjectSpace.#count_objects_size(result_hash = nil) -> Hash (40.0)

• 3.2

• モジュール関数

型ごとのオブジェクトサイズをバイト単位で格納したハッシュを返します。

型ごとのオブジェクトサイズをバイト単位で格納したハッシュを返します。

@param result_hash 戻り値のためのハッシュを指定します。省略した場合は新
しくハッシュを作成します。result_hash の内容は上書き
されます。プローブ効果を避けるために使用します。

戻り値の内容は完全ではない事に注意してください。この内容はあくまでもヒ
ントとして扱う必要があります。特に T_DATA の合計値は正しくないでしょう。

//emlist[例][ruby]{
ObjectSpace.count_objec...

• ObjectSpace

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

• 3.2

• モジュール関数

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

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

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

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

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

• ObjectSpace

ObjectSpace.#memsize_of(obj) -> Integer (40.0)

• 3.2

• モジュール関数

obj が消費するメモリ使用量をバイト単位で返します。

obj が消費するメモリ使用量をバイト単位で返します。

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

戻り値の内容は完全ではない事に注意してください。この内容はあくまでもヒ
ントとして扱う必要があります。特に T_DATA の値は正しくないでしょう。
2.2 以降では RVALUE のサイズを含んだ結果を返します。

本メソッドは C Ruby 以外では動作しません。

//emlist[例][ruby]{
require 'objspace'

ObjectSpace.memsize_of(10) # => 0
ObjectSpace.memsize_o...

• ObjectSpace

Process.#groups -> [Integer] (40.0)

• 3.2

• モジュール関数

補助グループ ID の配列を返します(実効グループ ID を含むかも知れません)。

補助グループ ID の配列を返します(実効グループ ID を含むかも知れません)。

返される配列の最大要素数は Process.#maxgroups です。

このメソッドは getgroups(2) の単純なラッパーです。
このことは以下の特徴がプラットフォームに依存することを意味します。

* 結果がソートされているかどうか
* 結果が実効グループ ID を含むかどうか
* グループ ID が重複している可能性があるかどうか

ソート済みで重複のないグループ ID の配列の取得は以下のようにできます:

//emlist[][ruby]{
Process.groups.uniq....

• Process

絞り込み条件を変える

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

• 3.2

• モジュール関数

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

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

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

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

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

• Kernel

Kernel.#test(cmd, file1, file2) -> bool (25.0)

• 3.2

• モジュール関数

２ファイル間のファイルテストを行います。

２ファイル間のファイルテストを行います。

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

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

: ?=
ファイル1とファイル2の最終更新時刻が等しい
: ?>
フ...

• Kernel

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

• 3.2

• モジュール関数

与えられたデータを 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.#urlsafe_encode64(bin, padding: true) -> String (22.0)

• 3.2

• モジュール関数

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

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

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

デフォルトでは戻り値は = によるパディングを含むことがあります。
パディングを含めたくない場合は、padding オプションに false を指定してください。

@param bin Base64 エンコードするデータを指定します。
@param padding false を指定した場合、 = によ...

• Base64

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

• 3.2

• モジュール関数

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

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

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

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

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

絞り込み条件を変える

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

• 3.2

• モジュール関数

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

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

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

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

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

• Benchmark
• Benchmark::Job

Benchmark.#measure(label = "") { ... } -> Benchmark::Tms (22.0)

• 3.2

• モジュール関数

与えられたブロックを実行して、経過した時間を Process.#times で計り、 Benchmark::Tms オブジェクトを生成して返します。

与えられたブロックを実行して、経過した時間を Process.#times で計り、
Benchmark::Tms オブジェクトを生成して返します。

Benchmark::Tms オブジェクトには to_s が定義されているので、
基本的には以下のように使います。

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

puts Benchmark::CAPTION
puts Benchmark.measure { "a"*1_000_000 }

#=>
#
# user system total real
# 1.1666...

• Benchmark
• Benchmark::Tms

Benchmark.#realtime { ... } -> Float (22.0)

• 3.2

• モジュール関数

与えられたブロックを評価して実行時間を計測して返します。 返り値の単位は、秒です。

与えられたブロックを評価して実行時間を計測して返します。
返り値の単位は、秒です。

//emlist[][ruby]{
require 'benchmark'
puts Benchmark.realtime { [0] * (10**8) } # => 1.0929416846483946
//}

• Benchmark

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

• 3.2

• モジュール関数

自然対数の底 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.2

• モジュール関数

円周率を 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

絞り込み条件を変える

BigMath.#atan(x, prec) -> BigDecimal (22.0)

• 3.2

• モジュール関数

x の逆正接関数を prec で指定した精度で計算します。単位はラジアンです。 x に無限大や NaN を指定した場合には NaN を返します。

x の逆正接関数を prec で指定した精度で計算します。単位はラジアンです。
x に無限大や NaN を指定した場合には NaN を返します。

@param x 計算対象の BigDecimal オブジェクト。単位はラジアン。

@param prec 計算結果の精度。

@raise ArgumentError x の絶対値が1以上の場合に発生します。

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

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

puts BigMath::atan(BigD...

• BigMath

BigMath.#cos(x, prec) -> BigDecimal (22.0)

• 3.2

• モジュール関数

x の余弦関数を prec で指定した精度で計算します。単位はラジアンです。x に無限大や NaN を指定した場合には NaN を返します。

x の余弦関数を prec で指定した精度で計算します。単位はラジアンです。x
に無限大や NaN を指定した場合には NaN を返します。

@param x 計算対象の BigDecimal オブジェクト。単位はラジアン。

@param prec 計算結果の精度。

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

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

puts BigMath::cos(BigDecimal('0.5'), 10) #=> 0.877582561890372716116...

• BigMath

BigMath.#exp(x, prec) -> BigDecimal (22.0)

• 3.2

• モジュール関数

x の指数関数を prec で指定した精度で計算します。

x の指数関数を prec で指定した精度で計算します。

x に正の無限大を指定した場合は正の無限大を返します。負の無限大を指定し
た場合には 0 を返します。NaN を指定した場合には NaNを返します。

@param x 計算対象の数値を Integer、BigDecimal、
Float、Rationalオブジェクトのいずれかで指定します。

@param prec 計算結果の精度を指定します。

@raise ArgumentError x に Integer、BigDecimal、
Float、Rational以外のオ...

• BigDecimal
• BigMath
• Integer

BigMath.#log(x, prec) -> BigDecimal (22.0)

• 3.2

• モジュール関数

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

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

x に無限大を指定した場合は無限大を返します。NaN を指定した場合には NaN
を返します。

@param x 計算対象の数値を Integer、Float、
Rational、BigDecimal オブジェクトのいずれかで指定
します。

@param prec 計算結果の精度を指定します。

@raise Math::DomainError x に 0 以下の数値か Complex オブジェクト
が指定された場合に発生します。

@rais...

• BigMath
• Complex
• Float
• Integer

BigMath.#sin(x, prec) -> BigDecimal (22.0)

• 3.2

• モジュール関数

x の正弦関数を prec で指定した精度で計算します。単位はラジアンです。x に無限大や NaN を指定した場合には NaN を返します。

x の正弦関数を prec で指定した精度で計算します。単位はラジアンです。x
に無限大や NaN を指定した場合には NaN を返します。

@param x 計算対象の BigDecimal オブジェクト。単位はラジアン。

@param prec 計算結果の精度。

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

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

puts BigMath::sin(BigDecimal('0.5'), 10) #=> 0.479425538604203000273...

• BigMath

絞り込み条件を変える

BigMath.#sqrt(x, prec) -> BigDecimal (22.0)

• 3.2

• モジュール関数

x の平方根を prec で指定した精度で計算します。

x の平方根を prec で指定した精度で計算します。

@param x 平方根を求める数。

@param prec 計算結果の精度。

@raise FloatDomainError x に 0 以下、もしくは NaN が指定された場合に発生します。

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

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

puts BigMath::sqrt(BigDecimal('2'), 10) #=> 0.1414213562373095048666666667e...

• BigMath

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

• 3.2

• モジュール関数

文字列 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.2

• モジュール関数

文字列 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

Etc.#confstr(name) -> String | nil (22.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.#getlogin -> String | nil (22.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.#nprocessors -> Integer (22.0)

• 3.2

• モジュール関数

有効な CPU コア数を返します。

有効な CPU コア数を返します。

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

• Etc

Etc.#sysconf(name) -> Integer | nil (22.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.#systmpdir -> String | nil (22.0)

• 3.2

• モジュール関数

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

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

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

• Etc

Etc.#uname -> {Symbol => String} (22.0)

• 3.2

• モジュール関数

uname(2) で取得したシステム情報を Hash で返します。

uname(2) で取得したシステム情報を Hash で返します。

@return 少なくとも :sysname, :nodename, :release, :version, :machine の
5 つのキーを持つ Hash を返します。

//emlist[例][ruby]{
require 'etc'
require 'pp'

pp Etc.uname
# => {:sysname=>"Linux",
# :nodename=>"boron",
# :release=>"2.6.18-6-xen-686",
# :version=>"#1 ...

• Etc
• Hash

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

• 3.2

• モジュール関数

指定されたオブジェクト 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.2

• モジュール関数

指定された 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.2

• モジュール関数

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

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

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

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

• Fiddle

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

• 3.2

• モジュール関数

ファイルが存在して、そのサイズが 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_real?(file) -> bool (22.0)

• 3.2

• モジュール関数

ファイルがカレントプロセスの実ユーザか実グループで実行できる時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには 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.#grpowned?(file) -> bool (22.0)

• 3.2

• モジュール関数

ファイルのグループ 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.#identical?(file1, file2) -> bool (22.0)

• 3.2

• モジュール関数

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

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

ruby 1.8.3 以前ではKernel.#test(?-, file1, file2)を使ってください。

open("a", "w") {}
p File.identical?("a", "a") #=> true
p File.identical?("a", "./a") #=> true
File.link("a", "b")
p File.identical...

• FileTest

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

• 3.2

• モジュール関数

ファイルのユーザがカレントプロセスの実効ユーザと等しい時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには 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.#readable?(file) -> bool (22.0)

• 3.2

• モジュール関数

ファイルがカレントプロセスにより読み込み可能な時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには 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.#setgid?(file) -> bool (22.0)

• 3.2

• モジュール関数

ファイルが 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.2

• モジュール関数

ファイルが 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 | nil (22.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.#socket?(file) -> bool (22.0)

• 3.2

• モジュール関数

ファイルがソケットである時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには 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.2

• モジュール関数

ファイルの 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.2

• モジュール関数

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

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

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

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

• FileTest

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

• 3.2

• モジュール関数

ファイルがカレントプロセスにより書き込み可能である時に真を返します。そうでない場合、ファイルが存在しない場合、あるいはシステムコールに失敗した場合などには 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.#zero?(file) -> bool (22.0)

• 3.2

• モジュール関数

ファイルが存在して、そのサイズが 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

FileUtils.#cd(dir, options = {}) -> 0 (22.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.#cd(dir, options = {}) {|dir| .... } -> object (22.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 = {}) -> 0 (22.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 (22.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.#chmod_R(mode, list, options = {}) -> Array (22.0)

• 3.2

• モジュール関数

ファイル list のパーミッションを再帰的に mode へ変更します。

ファイル list のパーミッションを再帰的に mode へ変更します。

@param mode パーミッションを8進数(absolute mode)か文字列(symbolic
mode)で指定します(FileUtils.#chmod 参照)。

@param list ファイルのリストを指定します。対象のファイルが一つの場合は文字列でも指定可能です。
二つ以上指定する場合は配列で指定します。

@param options :noop と :verbose が指定可能です。
c:FileUtils#options...

• FileUtils

FileUtils.#cmp(file_a, file_b) -> bool (22.0)

• 3.2

• モジュール関数

ファイル file_a と file_b の内容が同じなら真を返します。

ファイル file_a と file_b の内容が同じなら真を返します。

@param file_a ファイル名。

@param file_b ファイル名。

//emlist[][ruby]{
require 'fileutils'
FileUtils.cmp('somefile', 'somefile') #=> true
FileUtils.cmp('/dev/null', '/dev/urandom') #=> false
//}

• FileUtils

FileUtils.#compare_file(file_a, file_b) -> bool (22.0)

• 3.2

• モジュール関数

ファイル file_a と file_b の内容が同じなら真を返します。

ファイル file_a と file_b の内容が同じなら真を返します。

@param file_a ファイル名。

@param file_b ファイル名。

//emlist[][ruby]{
require 'fileutils'
FileUtils.cmp('somefile', 'somefile') #=> true
FileUtils.cmp('/dev/null', '/dev/urandom') #=> false
//}

• FileUtils

FileUtils.#identical?(file_a, file_b) -> bool (22.0)

• 3.2

• モジュール関数

ファイル file_a と file_b の内容が同じなら真を返します。

ファイル file_a と file_b の内容が同じなら真を返します。

@param file_a ファイル名。

@param file_b ファイル名。

//emlist[][ruby]{
require 'fileutils'
FileUtils.cmp('somefile', 'somefile') #=> true
FileUtils.cmp('/dev/null', '/dev/urandom') #=> false
//}

• FileUtils

FileUtils.#link(src, dest, options = {}) -> () (22.0)

• 3.2

• モジュール関数

src へのハードリンク dest を作成します。

src へのハードリンク dest を作成します。

src が一つの場合、
dest がすでに存在しディレクトリであるときは dest/src を作成します。
dest がすでに存在しディレクトリでないならば例外 Errno::EEXIST が発生します。
ただし :force オプションを指定したときは dest を上書きします。

src が複数の場合、
src[0] へのハードリンク dest/src[0]、src[1] への
ハードリンク dest/src[1] …を作成します。
dest がディレクトリでない場合は例外 Errno::ENOTDIR が発生します。

@param...

• FileUtils

絞り込み条件を変える