Ruby 1.9.3 リファレンスマニュアル > ライブラリ一覧 > socketライブラリ > UNIXServerクラス

class UNIXServer + UNIXSocket + BasicSocket + IO

クラスの継承リスト: UNIXServer < UNIXSocket < BasicSocket < IO < Enumerable < File::Constants < Object < Kernel < BasicObject

要約

UNIXストリーム型接続のサーバ側のソケットのクラス。

特異メソッド

binread(path, length = nil, offset = 0) -> String | nil

path で指定したファイルを open し、offset の所まで seek し、 length バイト読み込みます。

length を省略するとファイルの末尾まで読み込みます。

ファイルを開くときの mode は "rb:ASCII-8BIT" です。

[SEE_ALSO] IO.read

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

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

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

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

[PARAM] path:: ファイル名文字列
[PARAM] string:: 書き込む文字列
[PARAM] offset:: 書き込み開始位置

[SEE_ALSO] IO.write

copy_stream(src, dst, copy_length = nil) -> Integer

copy_stream(src, dst, copy_length, src_offset) -> Integer

指定された src から dst へコピーします。コピーしたバイト数を返します。

コピー元の src が IO オブジェクトの場合は、src のオフセットからファイル名の場合はファイルの最初からコピーを開始します。コピー先の dst に関しても同様です。

dst にファイル名を指定し、そのファイルが存在しない場合、ファイルは作成されます。ファイルが存在する場合は長さ 0 に切り詰められます。

src が IO オブジェクトでかつ src_offset が指定されている場合、 src のオフセット(src.pos)は変更されません。

[PARAM] src:: コピー元となる IO オブジェクトかファイル名を指定します。
[PARAM] dst:: コピー先となる IO オブジェクトかファイル名を指定します。
[PARAM] copy_length:: コピーする長さをバイト単位で指定します。最大 copy_length までコピーされます。 nil を指定した場合、コピーする長さに制限はありません。
[PARAM] src_offset:: コピーを始めるオフセットを数値で指定します。

do_not_reverse_lookup -> bool

Socket#do_not_reverse_lookup の Socket オブジェクト生成時のデフォルト値を返します。

この設定は大域的に作用します。

デフォルトは true です。

do_not_reverse_lookup=(bool)

BasicSocket#do_not_reverse_lookup の値を変更します。

[PARAM] bool:: この値が真ならアドレスからホスト名への逆引きを行わなくなります。

例:

require 'socket'

p TCPSocket.new('localhost', 'telnet').addr
TCPSocket.do_not_reverse_lookup = true
p TCPSocket.new('localhost', 'telnet').addr

=> ["AF_INET", 2253, "localhost", "127.0.0.1"]
   ["AF_INET", 2254, "127.0.0.1", "127.0.0.1"]

for_fd(fd) -> BasicSocket

ファイルディスクリプタ fd に対する新しいソケットを生成します。

返り値のクラスはどのクラスの for_fd を呼びだしたかによって決まります。

BasicSocket.for_fd(fd) # BasicSocket のインスタンスを返す
TCPSocket.for_fd(fd) # TCPSocket のインスタンスを返す

[PARAM] fd:: ファイルディスクリプタを指定します。
[RETURN]: 任意のソケットである fd から対応するソケットクラスのインスタンスを作り、それを返します。

new(fd, mode = "r", opt={}) -> IO

for_fd(fd, mode = "r", opt={}) -> IO

open(fd, mode = "r", opt={}) -> IO

open(fd, mode = "r" opt={}) {|io| ... } -> object

オープン済みのファイルディスクリプタ fd に対する新しい IO オブジェクトを生成して返します。

IO.open にブロックが与えられた場合、IO オブジェクトを生成しそれを引数としてブロックを実行します。ブロックの終了とともに fd はクローズされます。ブロックの結果を返します。 IO.new, IO.for_fd はブロックを受け付けません。

オプション引数

このメソッドは以下のオプションを利用できます。

:mode mode引数と同じ意味です
:external_encoding 外部エンコーディング。"-" はデフォルト外部エンコーディングの別名です。
:internal_encoding 内部エンコーディング。"-" はデフォルト内部エンコーディングの別名です。nilなら変換しません。
:encoding "extenc:intenc" の形で外部/内部エンコーディングを指定します。
:textmode 真を渡すと mode の "t" と同じ意味になります。
:binmode 真を渡すと mode の "b" と同じ意味になります。
:autoclose 偽を渡すと close時/GCでのファイナライザ呼出時に fd を close しません。

また、String#encode で説明されている :invalid => :replace などの変換オプションも指定することができます。外部エンコーディングから内部エンコーディングへの変換をするときに用いられます。

[PARAM] fd:: ファイルディスクリプタである整数を指定します。
[PARAM] mode:: Kernel.#open と同じ形式で IO のモードを指定します。File::Constants::RDONLY などの定数(数値)でモードを指定できます。詳細は組み込み関数 Kernel.#open を参照してください。 mode は省略可能で、省略時のデフォルトのモードは、 fcntl(2) で F_GETFL フラグが利用できる環境では第一引数で指定した fd のモードを引き継ぎ、利用できない環境では "r" になります。
[PARAM] opt:: オプション引数
[EXCEPTION] Errno::EXXX:: IO オブジェクトの生成に失敗した場合に発生します。

foreach(path, rs = $/) {|line| ... } -> nil

foreach(path, rs = $/) -> Enumerator

path で指定されたファイルの各行を引数としてブロックを繰り返し実行します。 path のオープンに成功すれば nil を返します。

ブロックが与えられなかった場合は、path で指定されたファイルの各行を繰り返す Enumerator オブジェクトを生成して返します。

テキスト読み込みメソッドとして動作します。 path が空ファイルの場合、何もせずに nil を返します。 Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドの出力を読み取ります。

[PARAM] path:: ファイル名を表す文字列か "|コマンド名" を指定します。
[PARAM] rs:: 行の区切りを文字列で指定します。rs に nil を指定すると行区切りなしとみなします。空文字列 "" を指定すると連続する改行を行の区切りとみなします(パラグラフモード)。
[EXCEPTION] Errno::EXXX:: path のオープンに失敗した場合、発生します。

[SEE_ALSO] $/

open(path) -> UNIXServer

new(path) -> UNIXServer

open(path) {|sock| ...} -> object

new(path) {|sock| ...} -> object

path で指定したパス名を用いて接続を受け付けるソケットを作成します。

ブロックを省略すると作成したサーバソケットを返します。

ブロックを渡した場合は、作成したソケットを引数としてそのブロックを呼びだし、ブロック終了時にソケットを閉じます。この場合にはブロックの評価値を返り値として返します。

[PARAM] path:: 接続を受け付けるパス名文字列

open(path) -> UNIXSocket

new(path) -> UNIXSocket

open(path) {|sock| ...} -> object

new(path) {|sock| ...} -> object

path で指定したパス名を用いてソケットを接続します。

ブロックを省略すると接続したソケットを返します。

ブロックを渡した場合は、接続したソケットを引数としてそのブロックを呼びだし、ブロック終了時にソケットを閉じます。この場合にはブロックの評価値を返り値として返します。

[PARAM] path:: 接続先のパス名文字列

pair(type=Socket::SOCK_STREAM, protocol=0) -> [UNIXSocket, UNIXSocket]

socketpair(type=Socket::SOCK_STREAM, protocol=0) -> [UNIXSocket, UNIXSocket]

相互に結合された UNIX ソケットのペアを含む2要素の配列を返します。

type にはソケットタイプを指定します。 Socket::SOCK_STREAM, Socket::SOCK_DGRAM, Socket::SOCK_RAW などの整数、:STREAM, :DGRAM, :RAW などのシンボル、 "STREAM" などの文字列が渡せます。

protocol にはプロトコルを指定します。0 は Unix domain でのデフォルト値が使われます。

s1, s2 = UNIXSocket.pair
s1.send "a", 0
s1.send "b", 0
p s2.recv(10) #=> "ab"

[PARAM] type:: ソケットタイプ
[PARAM] protocol:: プトロコル

pipe -> [IO]

pipe(ext_enc) -> [IO]

pipe(enc_str, opts={}) -> [IO]

pipe(ext_enc, int_enc, opts={}) -> [IO]

pipe {|read_io, write_io| ... } -> object

pipe(ext_enc) {|read_io, write_io| ... } -> object

pipe(enc_str, opt={}) {|read_io, write_io| ... } -> object

pipe(ext_enc, int_enc, opt={}) {|read_io, write_io| ... } -> object

pipe(2) を実行して、相互につながった2つの IO オブジェクトを要素とする配列を返します。

戻り値の配列は最初の要素が読み込み側で、次の要素が書き込み側です。

ブロックが渡された場合は、そのブロックに2つの IO オブジェクトが渡され、ブロックの返り値がこのメソッドの返り値となります。ブロック終了時に IO オブジェクトがもし close されていないならば close します(close されていてるオブジェクトはそのままです)。

得られる2つの IO オブジェクトのエンコーディングを引数で指定することができます。

[PARAM] enc_str:: 読み込み側の外部エンコーディングを文字列で指定します。文字列がコロンを挟んだ二つのエンコーディング名 "A:B" である場合最初のものが外部エンコーディング、次が内部エンコーディングを意味します。
[PARAM] ext_enc:: 読み込み側の外部エンコーディングを Encoding オブジェクトで指定します。
[PARAM] int_enc:: 読み込み側の内部エンコーディングを Encoding オブジェクトで指定します。
[PARAM] opt:: エンコーディングなどを設定するオプション引数(see IO.new)
[EXCEPTION] Errno::EXXX:: IO オブジェクトの作成に失敗した場合に発生します。

r, w = IO.pipe
p [r, w]            # => [#<IO:0x401b90f8>, #<IO:0x401b7718>]
Thread.new do
  w.puts "foo"
  w.close
end
p r.gets           # => "foo\n"

popen(command, mode = "r", opt={}) -> IO

popen(command, mode = "r", opt={}) {|io| ... } -> object

command をサブプロセスとして実行し、そのプロセスの標準入出力との間にパイプラインを確立します。生成したパイプを IO オブジェクトとして返します。

command が文字列の場合は、シェルを経由して子プロセスを実行します。 command が配列の場合は、シェルを経由せずに子プロセスを実行します。

p io = IO.popen("cat", "r+")  # => #<IO:0x401b75c8>
io.puts "foo"
io.close_write
p io.gets                     # => "foo\n"

ブロックが与えられた場合は生成した IO オブジェクトを引数にブロックを実行し、その結果を返します。ブロックの実行後、生成したパイプは自動的にクローズされます。

p IO.popen("cat", "r+") {|io|
  io.puts "foo"
  io.close_write
  io.gets
}
# => "foo\n"

[PARAM] command:: コマンド名を文字列か配列で指定します。配列が指定された場合には、シェルを経由せずに子プロセスを実行します。
[PARAM] mode:: オープンする IO ポートのモードを指定します。mode の詳細は Kernel.#open 参照して下さい。
[PARAM] opt:: エンコーディングなどを設定するオプション引数(see IO.new)
[EXCEPTION] Errno::EXXX:: パイプ、あるいは子プロセスの生成に失敗した場合に発生します。

popen("-", mode = "r", opt={}) -> IO

popen("-", mode = "r", opt={}) {|io| ... } -> object

第一引数に文字列 "-" が指定された時、fork(2) を行い子プロセスの標準入出力との間にパイプラインを確立します。親プロセスでは IO オブジェクトを返し、子プロセスでは nil を返します。

io = IO.popen("-", "r+")
if io  # parent
  io.puts "foo"
  p io.gets                   # => "child output: foo\n"
  io.close
else   # child
  s = gets
  print "child output: " + s
  exit
end

ブロックを与えられた場合、親プロセスでは生成した IO オブジェクトを引数にブロックを実行し、その結果を返します。ブロックの実行後、生成したパイプは自動的にクローズされます。子プロセスでは nil を引数にブロックを実行し終了します。

p IO.popen("-", "r+") {|io|
  if io   # parent
    io.puts "foo"
    io.gets
  else    # child
    s = gets
    puts "child output: " + s
  end
}
# => "child output: foo\n"

[PARAM] mode:: オープンする IO ポートのモードを指定します。mode の詳細は Kernel.#open 参照して下さい。
[PARAM] opt:: エンコーディングなどを設定するオプション引数(see IO.new)
[EXCEPTION] Errno::EXXX:: パイプ、あるいは子プロセスの生成に失敗した場合に発生します。

read(path, opt = {}) -> String | nil

read(path, length = nil, opt = {}) -> String | nil

read(path, length = nil, offset = 0, opt = {}) -> String | nil

path で指定されたファイルを offset 位置から length バイト分読み込んで返します。

既に EOF に達している場合は nil を返します。ただし、length に nil か 0 が指定されている場合は、空文字列 "" を返します。例えば、IO.read(空ファイル) は "" を返します。

引数 length が指定された場合はバイナリ読み込みメソッド、そうでない場合はテキスト読み込みメソッドとして動作します。

Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドの出力を読み取ります。

[PARAM] path:: ファイル名を表す文字列か "|コマンド名" を指定します。
[PARAM] length:: 読み込む長さを整数で指定します。nil であるか省略した場合には、EOF まで読み込みます。
[PARAM] offset:: 読み込みを始めるオフセットを整数で指定します。
[PARAM] opt:: ファイル path を open する時に使われるオプションを Hash で指定します。
[EXCEPTION] Errno::EXXX:: path のオープン、offset 位置への設定、ファイルの読み込みに失敗した場合に発生します。
[EXCEPTION] ArgumentError:: length が負の場合に発生します。

引数 opt で有効なキーと値は以下のとおりです。キーはいずれも Symbol オブジェクトです。

:encoding: 読み込んだ文字列のエンコーディングを指定します。読み込む長さを指定した場合はこれは無視されます。
:mode: IO.open のモードを指定します。 "r" で始まる文字列である必要があります。
:open_args: IO.open に渡される引数を配列で指定します。

これらの他、 :external_encoding など IO.open のオプション引数が指定できます。

[SEE_ALSO] IO.binread

例:

IO.read(empty_file)             #=> ""
IO.read(empty_file, 1)          #=> nil
IO.read(one_byte_file, 0, 10)   #=> ""
IO.read(one_byte_file, nil, 10) #=> ""
IO.read(one_byte_file, 1, 10)   #=> nil

readlines(path, rs = $/, opts={})

readlines(path, limit, opts={})

readlines(path, rs, limit, opts={})

path で指定されたファイルを全て読み込んで、その各行を要素としてもつ配列を返します。

Kernel.#open と同様 path の先頭が "|" ならば、"|" に続くコマンドの出力を読み取ります。

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

limit で最大読み込みバイト数を指定します。ただしマルチバイト文字が途中で切れないように余分に読み込む場合があります。

opts でファイルを開くときのオプションを指定します。エンコーディングなどを指定できます。 File.open と同様なのでそちらを参照してください。

[PARAM] path:: ファイル名を表す文字列か "|コマンド名" を指定します。
[PARAM] rs:: 行の区切りを文字列で指定します。rs に nil を指定すると行区切りなしとみなします。空文字列 "" を指定すると連続する改行を行の区切りとみなします(パラグラフモード)。
[PARAM] limit:: 最大の読み込みバイト数
[PARAM] opts:: ファイルを開くときのオプション引数
[EXCEPTION] Errno::EXXX:: path のオープン、ファイルの読み込みに失敗した場合に発生します。

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

select(2) を実行します。

与えられた入力/出力/例外待ちの IO オブジェクトの中から準備ができたものをそれぞれ配列にして、配列の配列として返します。タイムアウトした時には nil を返します。

Kernel.#select と同じです。

[PARAM] reads:: 入力待ちする IO オブジェクトの配列を渡します。
[PARAM] writes:: 出力待ちする IO オブジェクトの配列を渡します。
[PARAM] excepts:: 例外待ちする IO オブジェクトの配列を渡します。
[PARAM] timeout:: タイムアウトまでの時間を表す数値または nil を指定します。数値で指定したときの単位は秒です。nil を指定した時には IO がどれかひとつレディ状態になるまで待ち続けます。
[EXCEPTION] IOError:: 与えられた IO オブジェクトが閉じられていた時に発生します。
[EXCEPTION] Errno::EXXX:: select(2) に失敗した場合に発生します。

rp, wp = IO.pipe
mesg = "ping "
100.times{
  rs, ws, = IO.select([rp], [wp])
  if r = rs[0]
    ret = r.read(5)
    print ret
    case ret
    when /ping/
      mesg = "pong\n"
    when /pong/
      mesg = "ping "
    end
  end
  if w = ws[0]
    w.write(mesg)
  end
}

sysopen(path, mode = "r", perm = 0666) -> Integer

path で指定されるファイルをオープンし、ファイル記述子を返します。

IO.for_fd などで IO オブジェクトにしない限り、このメソッドでオープンしたファイルをクローズする手段はありません。

[PARAM] path:: ファイル名を表す文字列を指定します。
[PARAM] mode:: モードを文字列か定数の論理和で指定します。Kernel.#open と同じです。
[PARAM] perm:: open(2) の第 3 引数のように、ファイルを生成する場合のファイルのパーミッションを整数で指定します。Kernel.#open と同じです。
[EXCEPTION] Errno::EXXX:: ファイルのオープンに失敗した場合に発生します。

[SEE_ALSO] Kernel.#open

try_convert(obj) -> IO | nil

obj を to_io メソッドによって IO オブジェクトに変換します。変換できなかった場合は nil を返します。

IO.try_convert(STDOUT)     # => STDOUT
IO.try_convert("STDOUT")   # => nil

write(path, string, offset=nil, opt={}) -> Integer

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

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

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

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

[PARAM] path:: ファイル名文字列
[PARAM] string:: 書き込む文字列
[PARAM] offset:: 書き込み開始位置
[PARAM] opt:: ファイルを開くときのオプション引数

[SEE_ALSO] IO.binwrite

インスタンスメソッド

self << object -> self

object を出力します。object が文字列でない時にはメソッド to_s を用いて文字列に変換します。

以下のような << の連鎖を使うことができます。

STDOUT << 1 << " is a " << Fixnum << "\n"

[PARAM] object:: 出力したいオブジェクトを与えます。
[EXCEPTION] Errno::EXXX:: 出力に失敗した場合に発生します。

accept -> UnixSocket

クライアントからの接続要求を accept(2)で待ち受け、接続した UNIXSocket のインスタンスを返します。

例:

UNIXServer.open("/tmp/s") {|serv|
  c = UNIXSocket.open("/tmp/s")
  s = serv.accept
  s.write "from server"
  c.write "from client"
  p c.recv(20)    #=> "from server"
  p s.recv(20)    #=> "from client"
}

accept_nonblock -> UnixSocket

ソケットをノンブロッキングモードに設定した後、 accept(2) を呼び出します。

接続した UNIXSocket のインスタンスを返します。

accept(2) がエラーになった場合、Socket#accept と同じ例外が発生します。

Errno::EWOULDBLOCK, Errno::AGAIN, Errno::ECONNABORTED, [[Errno::EPROTO]] のいずれかの例外が発生した場合は、その例外には IO::WaitReadable が extend されます。それを利用してリトライ可能な例外を掴まえることができます。

require 'socket'
serv = UNIXServer.new("/tmp/sock")
begin # emulate blocking accept
  sock = serv.accept_nonblock
rescue IO::WaitReadable, Errno::EINTR
  IO.select([serv])
  retry
end
# sock is an accepted socket.

[SEE_ALSO] UNIXServer#accept

addr -> [String, String]

ソケットの接続情報を表す配列を返します。配列の各要素は第1要素が文字列 "AF_UNIX"、第2要素がパスを表す文字列です。

クライアント側はパスを持たないため空文字列となります。例:

UNIXServer.open("/tmp/s") {|serv|
  p serv.addr     #=> ["AF_UNIX", "/tmp/s"]
}

UNIXServer.open("/tmp/s") {|serv|
  c = UNIXSocket.open("/tmp/s")
  p c.peeraddr    #=> ["AF_UNIX", "/tmp/s"]
  p c.addr #=> ["AF_UNIX", ""]
}

[SEE_ALSO] UNIXSocket#peeraddr

advise(advice, offset=0, len=0) -> nil

posix_fadvise(2) を呼びだし、ファイルへのアクセスパターンをOSに知らせます。

advice には以下のいずれかのシンボルを指定します。

:normal - デフォルト
:sequential - データは前から順にアクセスされる
:random - データはランダムアクセスされる
:willneed - データはこの直後にアクセスされる
:dontneed - データは直後にはアクセスしない
:noreuse - データは一度しかアクセスされない

これらの advice が具体的に何をするのかはプラットフォーム依存です。

ここでいう「データ」は offset と len で特定することができます。 len が 0 ならば、offset からファイル末尾までを指定したことになります。デフォルトでは offset と len がともに 0 なので、ファイル全体を指定したことになります。

posix_fadvise をサポートしていないプラットフォーム上では何もしません。

[PARAM] advice:: アクセスパターンを表すシンボル
[PARAM] offset:: パターンを指定するデータの先頭位置
[PARAM] len:: パターンを指定するデータの長さ
[EXCEPTION] IOError:: ストリームが既に閉じられているときに発生する例外
[EXCEPTION] Errno::EBADF:: ファイルデスクリプタが不正であるときに発生する例外
[EXCEPTION] Errno::EINVAL:: advice が不正
[EXCEPTION] Errno::ESPIPE:: ファイルデスクリプタが FIFO か pipe を指している場合に発生する例外(Linux はこの場合には Errno::EINVAL を発生する)
[EXCEPTION] RangeError:: offset,lenが有効範囲から出ている場合に発生する例外

autoclose=(bool)

auto-close フラグを設定します。

フラグが設定されているオブジェクトは close時/GCでのファイナライザ呼出時にファイルデスクリプタを close します。設定されていない場合は close しません。

[PARAM] bool:: 真偽値でフラグを設定します

[SEE_ALSO] IO#autoclose?

f = open("/dev/null")
IO.for_fd(f.fileno)
# ...
f.gets # may cause IOError

f = open("/dev/null")
IO.for_fd(f.fileno).autoclose = true
# ...
f.gets # won't cause IOError

autoclose? -> bool

auto-close フラグを返します。

[SEE_ALSO] IO#autoclose=

binmode -> self

ストリームをバイナリモードにします。MSDOS などバイナリモードの存在する OS でのみ有効です。そうでない場合このメソッドは何もしません。

バイナリモードから通常のモードに戻す方法は再オープンしかありません。

[EXCEPTION] Errno::EXXX:: モードの変更に失敗した場合に発生します。

binmode? -> bool

自身がバイナリモードなら true を返します。そうでない場合、false を返します。

bytes -> Enumerator

自身を 1 バイトずつ整数としてイテレートするような Enumerator オブジェクトを生成して返します。

"hello".bytes.to_a        #=> [104, 101, 108, 108, 111]

each_char {|c| ... } -> self

chars {|c| ... } -> self

each_char -> Enumerator

chars -> Enumerator

self に含まれる文字を一文字つつブロックに渡して評価します。

self は読み込み用にオープンされていなければなりません。

ブロックを省略した場合は各文字について繰り返す Enumerator を返します。

[EXCEPTION] IOError:: self が読み込み用にオープンされていない場合に発生します。

f = File.new("testfile")
f.each_char {|c| print c, ' ' }   #=> #<File:testfile>

clone -> IO

dup -> IO

レシーバと同じ IO を参照する新しい IO オブジェクトを返します。参照しているファイル記述子は dup(2) されます。

clone の際に self は一旦 IO#flush されます。フリーズした IO の clone は同様にフリーズされた IO を返しますが、 dup は内容の等しいフリーズされていない IO を返します。

[EXCEPTION] IOError:: 既に close されていた場合に発生します。

close -> nil

入出力ポートをクローズします。

以後このポートに対して入出力を行うと例外 IOError が発生します。ガーベージコレクトの際にはクローズされていない IO ポートはクローズされます。 self がパイプでプロセスにつながっていれば、そのプロセスの終了を待ち合わせます。

[EXCEPTION] Errno::EXXX:: close に失敗した場合に発生します。
[EXCEPTION] IOError:: 既に close されていた場合に発生します。

close_on_exec=(bool)

自身に close-on-exec フラグを設定します。

このフラグをセットすると exec(2) 時にそのファイルデスクリプタを close します。

[SEE_ALSO] fcntl(2)

[PARAM] bool:: 自身の close-on-exec フラグを true か false で指定します。

f = open("/dev/null")
f.close_on_exec = true
system("cat", "/proc/self/fd/#{f.fileno}") # cat: /proc/self/fd/3: No such file or directory
f.closed?                #=> false

[SEE_ALSO] IO#close_on_exec?

close_on_exec? -> bool

自身に close-on-exec フラグが設定されていた場合 true を返します。そうでない場合に false を返します。

f = open("/dev/null")
f.close_on_exec?                 #=> false
f.close_on_exec = true
f.close_on_exec?                 #=> true
f.close_on_exec = false
f.close_on_exec?                 #=> false

[SEE_ALSO] IO#close_on_exec=

close_read -> nil

読み込み用の IO を close します。主にパイプや読み書き両用に作成した IO オブジェクトで使用します。

[EXCEPTION] IOError:: 自身が読み込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: close に失敗した場合に発生します。

close_write -> nil

書き込み用の IO を close します。

[EXCEPTION] IOError:: 自身が書き込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: close に失敗した場合に発生します。

closed? -> bool

ポートがクローズされている時に真を返します。

each_codepoint {|c| ... } -> self

codepoints {|c| ... } -> self

each_codepoint -> Enumerator

codepoints -> Enumerator

IO の各コードポイントに対して繰り返しブロックを呼びだします。

ブロックの引数にはコードポイントを表す整数が渡されます。

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

connect_address -> Addrinfo

ローカルマシン内で接続するのに適当なアドレスを Addrinfo オブジェクトで返します。

BasicSocket#local_address の返り値以下の点を除いては同じものを返します。

IPv4 の不定アドレス(0.0.0.0) は IPv4 のループバックアドレス(127.0.0.1) に置換される
IPv6 の不定アドレス(::) は IPv6 のループバックアドレス(::1) に置換される

BasicSocket#local_address が接続先として不適なアドレスを返す場合は例外 SocketError が発生します。

Addrinfo.tcp("0.0.0.0", 0).listen {|serv|
  p serv.connect_address #=> #<Addrinfo: 127.0.0.1:53660 TCP>
  serv.connect_address.connect {|c|
    s, _ = serv.accept
    p [c, s] #=> [#<Socket:fd 4>, #<Socket:fd 6>]
  }
}

[EXCEPTION] SocketError:: アドレスが接続に不適な場合に返します

[SEE_ALSO] BasicSocket#local_address

do_not_reverse_lookup -> bool

ソケットごとのアドレスからホスト名への逆引きの設定を返します。

真ならアドレスからホスト名への逆引きを行いません。

初期値はソケットを生成したときの BasicSocket.do_not_reverse_lookup の値になります。

[SEE_ALSO] BasicSocket#do_not_reverse_lookup=

do_not_reverse_lookup=(bool)

アドレスからホスト名への逆引きの設定をソケットごとに設定します。

[PARAM] bool:: この値が真ならアドレスからホスト名への逆引きを行わなくなります。

[SEE_ALSO] BasicSocket#do_not_reverse_lookup

each_byte {|ch| ... } -> self

each_byte -> Enumerator

IO の現在位置から 1 バイトずつ読み込み、それを整数として与え、ブロックを実行します。

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

バイナリ読み込みメソッドとして動作します。

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

each_line(rs = $/) {|line| ... } -> self

each_line(limit) {|line| ... } -> self

each_line(rs, limit) {|line| ... } -> self

each_line(rs = $/) -> Enumerator

each_line(limit) -> Enumerator

each_line(rs, limit) -> Enumerator

lines(rs = $/) {|line| ... } -> self

lines(limit) {|line| ... } -> self

lines(rs, limit) {|line| ... } -> self

lines(rs = $/) -> Enumerator

lines(limit) -> Enumerator

lines(rs, limit) -> Enumerator

IO の現在位置から 1 行ずつ文字列として読み込み、それを引数として与えられたブロックを実行します。

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

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

limit で最大読み込みバイト数を指定します。ただしマルチバイト文字が途中で切れないように余分に読み込む場合があります。

[PARAM] rs:: 行の区切りを文字列で指定します。rs に nil を指定すると行区切りなしとみなします。空文字列 "" を指定すると連続する改行を行の区切りとみなします(パラグラフモード)。
[PARAM] limit:: 最大の読み込みバイト数
[EXCEPTION] IOError:: 自身が読み込み用にオープンされていなければ発生します。

[SEE_ALSO] $/, IO#gets

eof -> bool

eof? -> bool

ストリームがファイルの終端に達した場合、true を返します。そうでない場合、false を返します。

f = File.new("testfile")
dummy = f.readlines
f.eof   #=> true

自身がパイプやソケットなどのストリームであった場合、相手がデータを送るか close するまでブロックします。

r, w = IO.pipe
Thread.new { sleep 10; w.close }
r.eof?  #=> 10秒ブロックしてから true を返す。

r, w = IO.pipe
Thread.new { sleep 10; w.puts "a" }
r.eof?  #=> 10秒ブロックしてから false を返す。

r, w = IO.pipe
r.eof?  # 永久にブロックします。

eof, eof? は入力バッファにデータを読み込むので、IO#sysread と同時に使うと正常に動作しません。

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

external_encoding -> Encoding | nil

IO の外部エンコーディングを返します。外部エンコーディングが指定されていない場合は nil を返します。

fcntl(cmd, arg = 0) -> Integer

IOに対してシステムコール fcntl を実行します。機能の詳細は fcntl(2) を参照してください。 fcntl(2) が返した整数を返します。

[PARAM] cmd:: IO に対するコマンドを、添付ライブラリ fcntl が提供している定数で指定します。
[PARAM] arg:: cmd に対する引数を整数、文字列、booleanのいずれかで指定します。整数の時にはその値を fcntl(2) に渡します。文字列の場合には Array#pack した構造体だとみなして渡します。 arg が nil か false の場合には 0を、true の場合には 1 を渡します。
[EXCEPTION] Errno::EXXX:: fcntl の実行に失敗した場合に発生します。
[EXCEPTION] IOError:: 既に close されている場合に発生します。

fdatasync -> 0 | nil

IO のすべてのバッファされているデータを直ちにディスクに書き込みます。

fdatasync(2) をサポートしていない OS 上では代わりに IO#fsync を呼びだします。

IO#fsync との違いは fdatasync(2) を参照してください。

[EXCEPTION] NotImplementedError:: fdatasync(2) も fsync(2) もサポートされていない OS で発生します。

fileno -> Integer

to_i -> Integer

ファイル記述子を表す整数を返します。

[EXCEPTION] IOError:: 既に close されている場合に発生します。

flush -> self

IO ポートの内部バッファをフラッシュします。

[EXCEPTION] IOError:: 自身が書き込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: fflush(3) が失敗した場合に発生します。

fsync -> 0 | nil

書き込み用の IO に対して、システムコール fsync(2) を実行します。IO#flush を行ったあと、(OSレベルで)まだディスクに書き込まれていないメモリ上にあるデータをディスクに書き出します。

成功すれば 0 を返します。 fsync(2) がサポートされていない場合は nil を返します。

[EXCEPTION] Errno::EXXX:: 失敗した場合に発生します。
[EXCEPTION] IOError:: 既に close されている場合に発生します。

getbyte -> Integer | nil

IO から1バイトを読み込み整数として返します。既に EOF に達していれば nil を返します。

f = File.new("testfile")
f.getbyte   #=> 84
f.getbyte   #=> 104

getc -> String | nil

IO ポートから外部エンコーディングに従い 1 文字読み込んで返します。 EOF に到達した時には nil を返します。

テキスト読み込みメソッドとして動作します。 IO#readchar との違いは EOF での振る舞いのみです。

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

例:

[SEE_ALSO] IO#readchar

getpeereid -> [Integer, Integer]

Unix ドメインソケットにおいて接続相手の euid と egid を返します。

配列の最初の要素が euid, 2番目の要素が egid です。

ソケットが Unix ドメインソケットでない場合の返り値は不定です。

Socket.unix_server_loop("/tmp/sock") {|s|
  begin
    euid, egid = s.getpeereid

    # Check the connected client is myself or not.
    next if euid != Process.uid

    # do something about my resource.
  ensure
    s.close
  end
}

getpeername -> String

接続の相手先のソケットの情報を取得します。sockaddr 構造体をパックした文字列を返します。getpeername(2) を参照してください。

例:

serv = TCPServer.open("", 0)
c = TCPSocket.open(*Socket.unpack_sockaddr_in(serv.getsockname).reverse)
s = serv.accept
addr = c.getpeername
p addr      #=> "\002\000\267\214\177\000\000\001\000\000\000\000\000\000\000\000"
p Socket.unpack_sockaddr_in(addr)   #=> [46988, "127.0.0.1"]
p addr == s.getsockname     #=> true

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

gets(limit) -> String | nil

gets(rs, limit) -> String | nil

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

テキスト読み込みメソッドとして動作します。読み込んだ文字列を変数 $_ にセットします。 IO#readline との違いは EOF での振る舞いのみです。

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

[PARAM] rs:: 行の区切りを文字列で指定します。rs に nil を指定すると行区切りなしとみなします。空文字列 "" を指定すると連続する改行を行の区切りとみなします(パラグラフモード)。
[PARAM] limit:: 最大の読み込みバイト数
[EXCEPTION] IOError:: 自身が読み込み用にオープンされていなければ発生します。

f = File.new("oneline_file")
f.gets                          #=> "This is line one\n"
$_                              #=> "This is line one\n"
f.gets                          #=> nil
$_                              #=> nil

[SEE_ALSO] $/, IO#readline

getsockname -> String

ソケットの情報を取得します。sockaddr 構造体をパックした文字列を返します。getsockname(2) を参照してください。

例:

serv = TCPServer.open("", 0)
p serv.getsockname        #=> "\002\000\236C\000\000\000\000\000\000\000\000\000\000\000\000"
p Socket.unpack_sockaddr_in(serv.getsockname)     #=> [40515, "0.0.0.0"]
c = TCPSocket.open(*Socket.unpack_sockaddr_in(serv.getsockname).reverse)
s = serv.accept

getsockopt(level, optname) -> Socket::Option

ソケットのオプションを取得します。getsockopt(2) を参照してください。取得したオプションのデータを Socket::Option で返します。

level, optname には Socket::SOL_SOCKET や Socket::SO_REUSEADDR といった整数値の他、文字列("SOL_SOCKET", prefixなしの "SOCKET")やシンボル(:SO_REUSEADDR, :REUSEADDR)を用いることができます。

[PARAM] level:: getsockopt(2) の第二引数のlevel
[PARAM] optname:: getsockopt(2) の第三引数のoption_name

[SEE_ALSO] BasicSocket#setsockopt

例:

serv = Socket.tcp_server_sockets("", 0)[0]
c = serv.local_address.connect
s = serv.accept
opt = c.getsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY)
# c.getsockopt("TCP", "NODELAY"),  なども可能
p opt #=> #<Socket::Option: INET TCP NODELAY 0>
p opt.bool #=> false (Nagle アルゴリズム有効)
p opt.unpack("i")[0] #=> 0 (Socket::Option#unpack が互換性のために存在する)
# 整数値の場合は Socket::Option#int を用いる
p c.getsockopt(:IP, :TTL).int #=> 64

internal_encoding -> Encoding | nil

IO の内部エンコーディングを返します。内部エンコーディングが指定されていない場合は nil を返します。

ioctl(cmd, arg = 0) -> Integer

IO に対してシステムコール ioctl を実行し、その結果を返します。機能の詳細は ioctl(2) を参照してください。

[PARAM] cmd:: IO に対するコマンドを整数で指定します。どのようなコマンドが使えるかはプラットフォームに依存します。
[PARAM] arg:: cmd に対する引数を指定します。整数の時にはその値を ioctl に渡します。文字列の場合には Array#pack した構造体だとみなして渡します。 arg が nil か false の場合には 0を、true の場合には 1 を渡します。
[EXCEPTION] IOError:: 既に close されている場合に発生します。

isatty -> bool

tty? -> bool

入出力ポートがttyに結合している時、真を返します。そうでない場合 false を返します。

[EXCEPTION] IOError:: 既に close されている場合に発生します。

lineno -> Integer

現在の行番号を整数で返します。実際には IO#gets が呼ばれた回数です。改行以外のセパレータで gets が呼ばれた場合など、実際の行番号と異なる場合があります。

[EXCEPTION] IOError:: 読み込み用にオープンされていなければ発生します。

f = File.new("testfile")
f.lineno                 #=> 0
f.gets                   #=> "This is line one\n"
f.lineno                 #=> 1
f.gets                   #=> "This is line two\n"
f.lineno                 #=> 2

[SEE_ALSO] $.

lineno=(number)

現在の行番号を number にセットします。 $. は次回の読み込みの時に更新されます。

[PARAM] number:: 行番号を整数で指定します。
[EXCEPTION] IOError:: 読み込み用にオープンされていなければ発生します。

f = File.new("testfile")
f.gets                     #=> "This is line one\n"
$.                         #=> 1
f.lineno = 1000
f.lineno                   #=> 1000
$.                         #=> 1
f.gets                     #=> "This is line two\n"
$.                         #=> 1001

[SEE_ALSO] $.

listen(backlog) -> 0

listen(2) を実行します。 (Socket#listenと同じ)

backlog は、クライアントからの接続要求を保留できる数です。 UNIXServer のインスタンスは最初は backlog の値は 5 で生成されます。

listen(2) が成功すれば 0 を返します。失敗すれば例外 Errno::EXXX が発生します。

[PARAM] backlog:: バックログの最大数(接続要求を保留できる数)

local_address -> Addrinfo

getsockname(2) で得られたローカルアドレス情報を Addrinfo オブジェクトとして返します。

返されたオブジェクトの Addrinfo#protocol は 0 を返すことに注意してください。

TCPSocket.open("www.ruby-lang.org", 80) {|s|
  p s.local_address #=> #<Addrinfo: 192.168.0.129:36873 TCP>
}

TCPServer.open("127.0.0.1", 1512) {|serv|
  p serv.local_address #=> #<Addrinfo: 127.0.0.1:1512 TCP>
}

[SEE_ALSO] BasicSocket#getsockname

path -> String

UNIX ソケットのパスを返します。

クライアント側はパスを持たないため空文字列となります。

例:

UNIXServer.open("/tmp/s") {|serv|
  p serv.path     #=> "/tmp/s"
}

peeraddr -> [String, String]

接続相手先ソケットの情報を表す配列を返します。配列の各要素は第1要素が文字列 "AF_UNIX"、第2要素がパスを表す文字列です。

例:

UNIXServer.open("/tmp/s") {|serv|
  c = UNIXSocket.open("/tmp/s")
  p c.peeraddr    #=> ["AF_UNIX", "/tmp/s"]
  p c.addr #=> ["AF_UNIX", ""]
}

[SEE_ALSO] UNIXSocket#addr

pid -> Integer | nil

自身が IO.popen で作られたIOポートなら、子プロセスのプロセス ID を返します。それ以外は nil を返します。

[EXCEPTION] IOError:: 既に close されている場合に発生します。

pos -> Integer

tell -> Integer

ファイルポインタの現在の位置を整数で返します。

[EXCEPTION] IOError:: 既に close されている場合に発生します。

pos=(n)

ファイルポインタを指定位置に移動します。 IO#seek(n, IO::SEEK_SET) と同じです。

[PARAM] n:: 先頭からのオフセットを整数で指定します。
[EXCEPTION] IOError:: 既に close されている場合に発生します。

print(*arg) -> nil

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

[PARAM] arg:: Kernel.#print と同じです。
[EXCEPTION] IOError:: 自身が書き込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: 出力に失敗した場合に発生します。

printf(format, *arg) -> nil

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

第一引数に IO を指定できないこと、引数を省略できないことを除けば Kernel.#printf と同じです。

[PARAM] format:: Kernel.#printf と同じです。sprintf フォーマットを参照してください。
[PARAM] arg:: Kernel.#printf と同じです。
[EXCEPTION] IOError:: 自身が書き込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: 出力に失敗した場合に発生します。

[SEE_ALSO] Kernel.#printf

putc(ch) -> object

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

[PARAM] ch:: 出力したい文字を、文字列か文字コード(整数)で与えます。
[EXCEPTION] IOError:: 自身が書き込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: 出力に失敗した場合に発生します。

[SEE_ALSO] Kernel.#putc

puts(*obj) -> nil

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

[PARAM] obj:: 出力したいオブジェクトを指定します。Kernel.#puts と同じです。
[EXCEPTION] IOError:: 自身が書き込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: 出力に失敗した場合に発生します。

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

#=>
this
is
a
test
1
nil
3

[SEE_ALSO] Kernel.#puts

read(length = nil, outbuf = "") -> String | nil

length バイト読み込んで、その文字列を返します。

引数 length が指定された場合はバイナリ読み込みメソッド、そうでない場合はテキスト読み込みメソッドとして動作します。既に EOF に達していれば nil を返します。ただし、length に nil か 0 が指定されている場合は、空文字列 "" を返します。例えば、open(空ファイル) {|f| f.read } は "" となります。

[PARAM] length:: 読み込むサイズを整数で指定します。 nil が指定された場合、EOF までの全てのデータを読み込んで、その文字列を返します。
[PARAM] outbuf:: 出力用のバッファを文字列で指定します。IO#read は読み込んだデータをその文字列オブジェクトに上書きして返します。指定した文字列オブジェクトがあらかじめ length 長の領域であれば、余計なメモリの割当てが行われません。指定した文字列の長さが length と異なる場合、その文字列は一旦 length 長に拡張(あるいは縮小)されたあと、実際に読み込んだデータのサイズになります。
[EXCEPTION] IOError:: 自身が読み込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: データの読み込みに失敗した場合に発生します。
[EXCEPTION] ArgumentError:: length が負の場合に発生します。

第二引数を指定した read の呼び出しでデータが空であった場合 (read が nil を返す場合)、outbuf は空文字列になります。

outbuf = "x" * 20;
io = File.open("/dev/null")
p io.read(10,outbuf)
p outbuf
=> nil
   ""

read_nonblock(maxlen, outbuf = "") -> String

IO をノンブロッキングモードに設定し、その後で read(2) システムコールにより長さ maxlen を上限として読み込み、文字列として返します。 EAGAIN, EINTR などは Errno::EXXX 例外として呼出元に報告されます。

発生した例外がErrno::EAGAIN、 Errno::EWOULDBLOCK である場合は、その例外オブジェクトに IO::WaitReadable が Object#extend されます。

なお、バッファが空でない場合は、read_nonblock はバッファから読み込みます。この場合、read(2) システムコールは呼ばれません。

このメソッドはノンブロッキングモードにする点を除いて IO#readpartial と同じであることに注意してください。

バイナリ読み込みメソッドとして動作します。既に EOF に達していれば EOFError が発生します。ただし、maxlen に 0 が指定されている場合は、空文字列 "" を返します。

[PARAM] maxlen:: 読み込む長さの上限を整数で指定します。
[PARAM] outbuf:: 文字列で指定します。IO#read_nonblock は読み込んだデータを outbuf に破壊的に格納し、返り値は outbuf となります。outbuf は一旦 maxlen 長に拡張(あるいは縮小)されたあと、実際に読み込んだデータのサイズになります。read(2) システムコールが 0 を返した場合は、空文字列になります。
[EXCEPTION] IOError:: 自身が読み込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: read(2) システムコールの結果としてエラーが起きた場合に発生します。
[EXCEPTION] EOFError:: read(2) システムコールが 0 を返した場合に発生します。これは、IO が既に EOF に達していることを意味します。

readbyte -> Integer

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

[EXCEPTION] EOFError:: 既に EOF に達している場合に発生します。

readchar -> String

IO ポートから 1 文字読み込んで返します。 EOF に到達した時には EOFError が発生します。

テキスト読み込みメソッドとして動作します。 IO#getc との違いは EOF での振る舞いのみです。

[EXCEPTION] EOFError:: EOF に到達した時に発生します。
[EXCEPTION] IOError:: 自身が読み込み用にオープンされていなければ発生します。

f = File.new("testfile")
p f.readchar                   #=> "い"
p f.readchar                   #=> "ろ"
p f.readchar                   #=> "は"
f.read
f.readchar                   #=> EOFError

[SEE_ALSO] IO#getc

readline(rs = $/) -> String

readline(limit) -> String

readline(rs, limit) -> String

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

テキスト読み込みメソッドとして動作します。読み込んだ文字列を変数 $_ にセットします。IO#gets との違いは EOF での振る舞いのみです。

limit で最大読み込みバイト数を指定します。ただしマルチバイト文字が途中で切れないように余分に読み込む場合があります。

[PARAM] rs:: 行の区切りを文字列で指定します。rs に nil を指定すると行区切りなしとみなします。空文字列 "" を指定すると連続する改行を行の区切りとみなします(パラグラフモード)。
[PARAM] limit:: 最大の読み込みバイト数
[EXCEPTION] EOFError:: EOF に到達した時に発生します。
[EXCEPTION] IOError:: 自身が読み込み用にオープンされていなければ発生します。

f = File.new("oneline_file")
f.readline                      #=> "This is line one\n"
$_                              #=> "This is line one\n"
f.readline                      #=> EOFError
$_                              #=> nil

[SEE_ALSO] $/, IO#gets

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

readlines(limit) -> [String]

readlines(rs = $/, limit) -> [String]

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

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

limit で最大読み込みバイト数を指定します。ただしマルチバイト文字が途中で切れないように余分に読み込む場合があります。

[PARAM] rs:: 行の区切りを文字列で指定します。rs に nil を指定すると行区切りなしとみなします。空文字列 "" を指定すると連続する改行を行の区切りとみなします(パラグラフモード)。
[PARAM] limit:: 最大の読み込みバイト数
[EXCEPTION] IOError:: 自身が読み込み用にオープンされていなければ発生します。

[SEE_ALSO] $/, IO#gets

readpartial(maxlen, outbuf = "") -> String

IO から長さ maxlen を上限として読み込み、文字列として返します。即座に得られるデータが存在しないときにはブロックしてデータの到着を待ちます。即座に得られるデータが 1byte でも存在すればブロックしません。

readpartial はブロックを最小限に抑えることによって、パイプ、ソケット、端末などのストリームに対して適切に動作するよう設計されています。 readpartial がブロックするのは次の全ての条件が満たされたときだけです。

IO オブジェクト内のバッファが空
ストリームにデータが到着していない
ストリームが EOF になっていない

これらの条件が満たされる場合、何らかのデータが到着するか EOF になるまで readpartial はブロックします。

readpartial の結果は以下のようになります。

バッファが空でなければ、そのバッファのデータを読み込んで返します。
ストリームにデータがあれば、ストリームからデータを読み込んで返します。
ストリームが EOF になっていれば、例外 EOFError を発生させます。

例えば、パイプに対しては次のように動作します。

r, w = IO.pipe           #               buffer          pipe content
w << "abc"               #               ""              "abc".
r.readpartial(4096)      #=> "abc"       ""              ""
r.readpartial(4096)      # バッファにもパイプにもデータがないのでブロックする

r, w = IO.pipe           #               buffer          pipe content
w << "abc"               #               ""              "abc"
w.close                  #               ""              "abc" EOF
r.readpartial(4096)      #=> "abc"       ""              EOF
r.readpartial(4096)      # 例外 EOFError 発生

r, w = IO.pipe           #               buffer          pipe content
w << "abc\ndef\n"        #               ""              "abc\ndef\n"
r.gets                   #=> "abc\n"     "def\n"         ""
w << "ghi\n"             #               "def\n"         "ghi\n"
r.readpartial(4096)      #=> "def\n"     ""              "ghi\n"
r.readpartial(4096)      #=> "ghi\n"     ""              ""

なお、readpartial は nonblock フラグに影響されません。つまり、nonblock フラグが設定されていて sysread であれば Errno::EAGAIN になる場合でもブロックします。

また、readpartial の挙動は sysread によく似ています。とくに、バッファが空の場合には同じ挙動を示します。ただし、EAGAIN および EINTR エラーは内部で発生したとしても通知されず、データが到着するまでブロックし続けます。

[PARAM] maxlen:: 読み込む長さの上限を整数で指定します。
[PARAM] outbuf:: 文字列で指定します。IO#readpartial は読み込んだデータを outbuf に破壊的に格納し、返り値は outbuf となります。outbuf は一旦 maxlen 長に拡張(あるいは縮小)されたあと、実際に読み込んだデータのサイズになります。IO が既に EOF に達していれば、空文字列になります。
[EXCEPTION] IOError:: 自身が読み込み用にオープンされていなければ発生します。
[EXCEPTION] EOFError:: IO が既に EOF に達していれば発生します。

recv(maxlen, flags = 0) -> String

ソケットからデータを受け取り、文字列として返します。 maxlen は受け取る最大の長さを指定します。 flags については recv(2) を参照してください。flags のデフォルト値は 0 です。flags の指定に必要な定数は Socket クラスで定義されています。(例: Socket::MSG_PEEK)

内部で呼び出す recv(2) が 0 を返した場合、このメソッドは "" を返します。この意味はソケットによって異なります。たとえば TCP では EOF を意味しますし、 UDP では空のパケットを読み込んだことを意味します。

[PARAM] maxlen:: 受け取る文字列の最大の長さを指定します。
[PARAM] flags:: recv(2) を参照してください。
[EXCEPTION] IOError:
[EXCEPTION] Errno::EXXX:: recvfrom(2) がエラーになった場合などに発生します。

例:

s1, s2 = UNIXSocket.pair
s1.write "a"
s1.close
p s2.recv(10, Socket::MSG_PEEK)   #=> "a"
p s2.recv(10)                     #=> "a"
p s2.recv(10)                     #=> ""

recv_io(klass=IO, mode=nil) -> Fixnum|IO|object

ソケットの接続先からファイルディスクリプタを受け取ります。

klass が nil の場合、ファイルディスクリプタが Fixnum として返されます。

klass が nil でない場合、 klass.for_fd(fd[, mode]) が呼ばれ、その値が返されます。

例:

s1, s2 = UNIXSocket.pair
s1.send_io STDOUT
io = s2.recv_io
p File.identical?(io, STDOUT)     #=> true

[PARAM] klass:: 受け取ったファイルディスクリプタを変換するためのクラス
[PARAM] mode:: for_fd に渡すファイルモード

recv_nonblock(maxlen, flags = 0) -> String

ソケットをノンブロッキングモードに設定した後、 recvfrom(2) でソケットからデータを受け取ります。

引数、返り値は BasicSocket#recv と同じです。

recvfrom(2) がエラーになった場合、 EAGAIN, EINTR を含め例外 Errno::EXXX が発生します。

[PARAM] maxlen:: 受け取る文字列の最大の長さを指定します。
[PARAM] flags:: recv(2) を参照してください。
[EXCEPTION] IOError:
[EXCEPTION] Errno::EXXX:: recvfrom(2) がエラーになった場合などに発生します。

recvfrom(maxlen, flags = 0) -> [String [String, String]]

recvfrom(2) を用いてソケットからメッセージを受け取ります。

maxlen で受け取るメッセージの最大長をバイト数で指定します。

flags には Socket::MSG_* という名前の定数の bitwise OR を渡します。

戻り値は文字列と相手ソケットのパスのペアです。

例:

UNIXServer.open("/tmp/s") {|serv|
  c = UNIXSocket.open("/tmp/s")
  s = serv.accept
  s.send "a", 0
  p c.recvfrom(10)[0]     #=> "a"
}

[PARAM] maxlen:: 受け取るメッセージの最大長
[PARAM] flags:: フラグ

recvmsg(maxmesglen=nil, flags=0, maxcontrollen=nil, opts={}) -> [String, Addrinfo, Integer, *Socket::AncillaryData]

recvmsg(2) を用いてメッセージを受け取ります。

このメソッドはブロックします。ノンブロッキング方式で通信したい場合は BasicSocket#recvmsg_nonblock を用います。

maxmesglen, maxcontrollen で受け取るメッセージおよび補助データ (Socket::AncillaryData)の最大長をバイト単位で指定します。省略した場合は必要なだけ内部バッファを拡大してデータが切れないようにします。

flags では Socket::MSG_* という名前の定数の biwsise OR を取ったものを渡します。

opts にはその他のオプションを渡します。今のところ :scm_right => bool というオプションのみ利用できます。このオプションに真を渡すと、 SCM_RIGHTS 制御メッセージを受け取ったときに、メッセージに含まれる IO オブジェクトを生成します。詳しくは Socket::AncillaryData#unix_rights を参照してください。

返り値は配列で得られます。

返り値の配列の最初の要素は受け取ったメッセージを表す文字列です。

2番目の要素は connection-less socket の場合には送り元のアドレスが Addrinfo オブジェクトとして含まれています。 TCP のような connection-oriented socket の場合は何が含まれているかはプラットフォーム依存です。

3番目の要素は受け取ったメッセージに付加されているフラグで、 Socket::MSG_* 定数の bitwise OR で表現されています。

残りの要素は補助データ(Socket::AncillaryData オブジェクト)です。

# UnixSocket#recv_io を recvmsg で実装する例
mesg, sender_sockaddr, rflags, *controls = sock.recvmsg(:scm_rights=>true)
controls.each {|ancdata|
  if ancdata.cmsg_is?(:SOCKET, :RIGHTS)
    return ancdata.unix_rights[0]
  end
}

[PARAM] maxmesglen:: 受け取るメッセージの最大長
[PARAM] flags:: フラグ
[PARAM] maxcontrollen:: 受け取る補助データの最大長
[PARAM] opts:: ハッシュオプション

recvmsg_nonblock(maxmesglen=nil, flags=0, maxcontrollen=nil, opts={}) -> [String, Addrinfo, Integer, *Socket::AncillaryData]

recvmsg(2) を用いてノンブロッキング方式でメッセージを受け取ります。

ブロッキングの有無以外は BasicSocket#recvmsg と同じです。詳しくはそちらを参照してください。

[PARAM] maxmesglen:: 受け取るメッセージの最大長
[PARAM] flags:: フラグ
[PARAM] maxcontrollen:: 受け取る補助データの最大長
[PARAM] opts:: ハッシュオプション

remote_address -> Addrinfo

getpeername(2) で得られたリモートアドレス情報を Addrinfo オブジェクトとして返します。

返されたオブジェクトの Addrinfo#protocol は 0 を返すことに注意してください。

TCPSocket.open("www.ruby-lang.org", 80) {|s|
  p s.remote_address #=> #<Addrinfo: 221.186.184.68:80 TCP>
}

TCPServer.open("127.0.0.1", 1728) {|serv|
  c = TCPSocket.new("127.0.0.1", 1728)
  s = serv.accept
  p s.remote_address #=> #<Addrinfo: 127.0.0.1:36504 TCP>
}

[SEE_ALSO] BasicSocket#getpeername

reopen(io) -> self

自身を指定された io に繋ぎ換えます。

クラスも io に等しくなることに注意してください。 IO#pos, IO#lineno などは指定された io と等しくなります。

[PARAM] io:: 自身を繋ぎ換えたい IO オブジェクトを指定します。
[EXCEPTION] IOError:: 指定された io が close されている場合に発生します。

reopen(path) -> self

reopen(path, mode) -> self

path で指定されたファイルにストリームを繋ぎ換えます。

第二引数を省略したとき self のモードをそのまま引き継ぎます。 IO#pos, IO#lineno などはリセットされます。

[PARAM] path:: パスを表す文字列を指定します。
[PARAM] mode:: パスを開く際のモードを文字列で指定します。
[EXCEPTION] Errno::EXXX:: 失敗した場合に発生します。

[SEE_ALSO] Kernel.#open

rewind -> 0

ファイルポインタを先頭に移動します。IO#lineno は 0 になります。

[EXCEPTION] IOError:: 既に close されている場合に発生します。

f = File.new("testfile")
f.readline               #=> "This is line one\n"
f.rewind                 #=> 0
f.lineno                 #=> 0
f.readline               #=> "This is line one\n"

seek(offset, whence = IO::SEEK_SET) -> 0

ファイルポインタを whence の位置から offset だけ移動させます。 offset 位置への移動が成功すれば 0 を返します。

[PARAM] offset:: ファイルポインタを移動させるオフセットを整数で指定します。
[PARAM] whence:: 値は以下のいずれかです。

IO::SEEK_SET: ファイルの先頭から (デフォルト)
IO::SEEK_CUR: 現在のファイルポインタから
IO::SEEK_END: ファイルの末尾から

[EXCEPTION] Errno::EXXX:: ファイルポインタの移動に失敗した場合に発生します。
[EXCEPTION] IOError:: 既に close されていた場合に発生します。

f = File.new("testfile")
f.seek(-13, IO::SEEK_END)   #=> 0
f.readline                  #=> "And so on...\n"

[SEE_ALSO] IO#sysseek

send(mesg, flags, dest_sockaddr = nil) -> Fixnum

ソケットを介してデータを送ります。flags に関しては send(2) を参照してください。connect していないソケットに対しては送り先である dest_sockaddr を指定する必要があります。実際に送ったデータの長さを返します。

dest_sockaddr には「ソケットアドレス構造体を pack した文字列」を指定します。

データの送信に失敗した場合は例外 Errno::EXXX が発生します。

[PARAM] mesg:: 送信するデータを文字列で指定します。
[PARAM] flags:: send(2) の flags を参照してください。
[PARAM] dest_sockaddr:: 「ソケットアドレス構造体を pack した文字列」を指定します。
[EXCEPTION] Errno::EXXX:: データの送信に失敗した場合に発生します。

例:

s = UDPSocket.new
sockaddr = Socket.sockaddr_in("discard", "localhost")
s.send("The king has donkey ears!", 0, sockaddr)

send_io(io) -> nil

IO や Fixnum に対応するファイルディスクリプタをソケットの接続先に送ります。

s1, s2 = UNIXSocket.pair

s1.send_io STDOUT
stdout = s2.recv_io

p STDOUT.fileno #=> 1
p stdout.fileno #=> 6

stdout.puts "hello" # outputs "hello\n" to standard output.

[PARAM] io:: 送るファイルディスクリプタ(整数 or IOオブジェクト)

sendmsg(mesg, flags=0, dest_sockaddr=nil, *controls) -> Integer

sendmsg(2) を用いてメッセージを送ります。

このメソッドはブロックします。ノンブロッキング方式で通信したい場合は BasicSocket#sendmsg_nonblock を用います。

ソケットが connection-less の場合は dest_sockaddr で通信先のアドレスを指定しなければなりません。Socket.sockaddr_in の返り値や Addrinfo オブジェクトを引数として渡すことができます。

controls には補助データ(ancillary data)を渡します。 Socket::AncillaryData のインスタンスや 3要素(cmsg_level, cmsg_type, cmsg_data) の配列を用いることができます。

送ったバイト数を返します。

# UnixSocket#send_io の実装例
# use Socket::AncillaryData.
ancdata = Socket::AncillaryData.int(:UNIX, :SOCKET, :RIGHTS, io.fileno)
sock.sendmsg("a", 0, nil, ancdata)

# use 3-element array.
ancdata = [:SOCKET, :RIGHTS, [io.fileno].pack("i!")]
sock.sendmsg("\0", 0, nil, ancdata)

[PARAM] mesg:: メッセージ文字列
[PARAM] flags:: フラグ(Socket::MSG_* という定数の bitwise OR を取ったもの)
[PARAM] dest_sockaddr:: 通信先のアドレス
[PARAM] controls:: 補助データの配列

[SEE_ALSO] BasicSocket#sendmsg_nonblock

sendmsg_nonblock(mesg, flags=0, dest_sockaddr=nil, *controls) -> Integer

sendmsg(2) を用いてノンブロッキング方式でメッセージを送ります。

詳しくは BasicSocket#sendmsg を見てください。

[RETURN]: 送ったバイト数
[PARAM] mesg:: メッセージ文字列
[PARAM] flags:: フラグ(Socket::MSG_* という定数の bitwise OR を取ったもの)
[PARAM] dest_sockaddr:: 通信先のアドレス
[PARAM] controls:: 補助データの配列

[SEE_ALSO] BasicSocket#sendmsg

set_encoding(enc_str, opt={}) -> self

set_encoding(ext_enc) -> self

set_encoding(ext_enc, int_enc, opt={}) -> self

IO のエンコーディングを設定します。

引数が "A:B" のようにコロンで区切られた文字列の場合は、 A を外部エンコーディング、 B を内部エンコーディングに指定します。

引数が一つで、上のような形式でない場合には、それが外部エンコーディングと見なされます。

引数が2つの場合はそのそれぞれを外部エンコーディング、内部エンコーディングに設定します。

opt のハッシュで外部エンコーディングを内部エンコーディングに変換する際のオプションを指定します。詳しくは String#encode を参照してください。

[PARAM] enc_str:: エンコーディングを表す文字列を指定します。"A:B" のようにコロンで区切られた文字列を指定した場合 A が外部エンコーディング、B が内部エンコーディングを表します。
[PARAM] ext_enc:: 外部エンコーディングを表す文字列か Encoding オブジェクトを指定します。
[PARAM] int_enc:: 内部エンコーディングを表す文字列か Encoding オブジェクトを指定します。
[PARAM] opt:: エンコーディング変換のオプション

例:

io = File.open(file)
io.set_encoding("ASCII-8BIT", "EUC-JP")

setsockopt(level, optname, optval) -> 0

setsockopt(socketoption) -> 0

ソケットのオプションを設定します。setsockopt(2) を参照してください。

optval には文字列、整数、真偽値(true or false)を渡すことができます。文字列の場合には setsockopt(2) にはその文字列と長さが渡されます。整数の場合はintへのポインタが渡されます。 true/falseの場合は0/1という整数と解釈され、そのメモリ領域の intポインタを渡します。

引数が1つの場合は Socket::Option で設定値を表現します。

# 真偽値の場合
#setsockopt could be called like this:
sock.setsockopt(:SOCKET, :REUSEADDR, true)
sock.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR, true)
sock.setsockopt(Socket::Option.bool(:INET, :SOCKET, :REUSEADDR, true))

# 整数値の場合
#setsockopt could be called like this:
sock.setsockopt(:IP, :TTL, 255)
sock.setsockopt(Socket::IPPROTO_IP, Socket::IP_TTL, 255)
sock.setsockopt(Socket::Option.int(:INET, :IP, :TTL, 255))

# より複雑な場合
optval = IPAddr.new("224.0.0.251").hton +
         IPAddr.new(Socket::INADDR_ANY, Socket::AF_INET).hton
sock.setsockopt(Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, optval)

[PARAM] level:: setsockopt(2) の level を参照してください。
[PARAM] optname:: setsockopt(2) の option_name を参照してください。
[PARAM] optval:: 設定値
[PARAM] socketoption:: 設定値を表す Socket::Option オブジェクト
[EXCEPTION] Errno::EXXX:: オプションの設定に失敗した場合発生します。

[SEE_ALSO] BasicSocket#getsockopt

shutdown(how = Socket::SHUT_RDWR) -> 0

ソケットの以降の接続を終了させます。

how の値によって以下のように接続が終了します。

Socket::SHUT_RD: それ以降の受信が拒否されます
Socket::SHUT_WR: それ以降の送信が拒否されます
Socket::SHUT_RDWR: それ以降の送信、受信ともに拒否されます

how を省略すると Socket::SHUT_RDWR を指定したことになります。 shutdown(2) を参照してください。

[PARAM] how:: 接続の終了の仕方を Socket::SHUT_RD, Socket::SHUT_WR, Socket::SHUT_RDWR などで指定します。
[EXCEPTION] Errno::EXXX:: ソケットの以降の接続を終了操作が失敗した場合に発生します。
[EXCEPTION] ArgumentError:: how に範囲外の整数を入力した場合に発生します。
[EXCEPTION] SecurityError:: セーフレベルが 4 以上で、ソケットに汚染マークがついていない場合発生します。

stat -> File::Stat

ファイルのステータスを含む File::Stat オブジェクトを生成して返します。

[EXCEPTION] Errno::EXXX:: ステータスの読み込みに失敗した場合に発生します。
[EXCEPTION] IOError:: 既に close されていた場合に発生します。

[SEE_ALSO] File#lstat, File.stat, File.lstat

sync -> bool

現在の出力が同期モードならば true を返します。そうでない場合は false を返します。

[EXCEPTION] IOError:: 既に close されていた場合に発生します。

sync=(newstate)

自身を同期モードに設定すると、出力関数の呼出毎にバッファがフラッシュされます。

[PARAM] newstate:: 自身を同期モードに設定するかを boolean で指定します。
[EXCEPTION] IOError:: 既に close されていた場合に発生します。

sysaccept -> Integer

接続したクライアントのソケットをファイル記述子で返すことを除けば UNIXServer#accept と同じです。

例:

UNIXServer.open("/tmp/s") {|serv|
  c = UNIXSocket.open("/tmp/s")
  p serv.sysaccept        #=> 6
}

sysread(maxlen, outbuf = "") -> String

read(2) を用いて入力を行ない、入力されたデータを含む文字列を返します。stdio を経由しないので gets や getc や eof? などと混用すると思わぬ動作をすることがあります。

[PARAM] maxlen:: 入力のサイズを整数で指定します。
[PARAM] outbuf:: 出力用のバッファを文字列で指定します。IO#sysread は読み込んだデータをその文字列オブジェクトに上書きして返します。指定した文字列オブジェクトがあらかじめ maxlen 長の領域であれば、余計なメモリの割当てが行われません。指定した文字列の長さが maxlen と異なる場合、その文字列は一旦 maxlen 長に拡張(あるいは縮小)されたあと、実際に読み込んだデータのサイズになります。
[EXCEPTION] IOError:: 自身が読み込み用にオープンされていなければ発生します。
[EXCEPTION] EOFError:: IO が既に EOF に達していれば発生します。
[EXCEPTION] Errno::EXXX:: データの読み込みに失敗した場合に発生します。

第二引数を指定した sysread の呼び出しでデータが空であった場合(sysread が例外 EOFError を発生させる場合)、 outbuf は空文字列になります。

outbuf = "x" * 20;
io = File.open("/dev/null")
p((io.sysread(10,outbuf) rescue nil))
p outbuf
=> nil
   ""

sysseek(offset, whence = IO::SEEK_SET) -> Integer

lseek(2) と同じです。IO#seek では、 IO#sysread, IO#syswrite と併用すると正しく動作しないので代わりにこのメソッドを使います。位置 offset への移動が成功すれば移動した位置(ファイル先頭からのオフセット)を返します。

書き込み用にバッファリングされた IO に対して実行すると警告が出ます。

File.open("/dev/zero") {|f|
  buf = f.read(3)
  f.sysseek(0)
}
# => -:3:in `sysseek': sysseek for buffered IO (IOError)

File.open("/dev/null", "w") {|f|
  f.print "foo"
  f.sysseek(0)
}
# => -:3: warning: sysseek for buffered IO

[PARAM] offset:: ファイルポインタを移動させるオフセットを整数で指定します。
[PARAM] whence:: 値は以下のいずれかです。

IO::SEEK_SET: ファイルの先頭から (デフォルト)
IO::SEEK_CUR: 現在のファイルポインタから
IO::SEEK_END: ファイルの末尾から

[EXCEPTION] IOError:: 読み込み用にバッファリングされた IO に対して実行すると発生します。既に close されていた場合にも発生します。
[EXCEPTION] Errno::EXXX:: 移動に失敗した場合に発生します。

[SEE_ALSO] IO#seek

syswrite(string) -> Integer

write(2) を用いて string を出力します。 string が文字列でなければ to_s による文字列化を試みます。実際に出力できたバイト数を返します。

stdio を経由しないので他の出力メソッドと混用すると思わぬ動作をすることがあります。

[PARAM] string:: 自身に書き込みたい文字列を指定します。
[EXCEPTION] IOError:: 自身が書き込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: 出力に失敗した場合に発生します。

to_io -> self

self を返します。

ungetbyte(c) -> nil

指定したバイト列を書き戻します。

2バイト以上の書き戻しは仕様として保証しません。

このメソッドはバッファを経由しない読み出し(IO#sysread など) には影響しません。

[PARAM] c:: バイト列(文字列)、もしくは0から255までの整数

例:

f = File.new("testfile")   #=> #<File:testfile>
b = f.getbyte              #=> 0x38
f.ungetbyte(b)             #=> nil
f.getbyte                  #=> 0x38

ungetc(char) -> nil

指定された char を読み戻します。

[PARAM] char:: 読み戻したい1文字かそのコードポイントを指定します。
[EXCEPTION] IOError:: 読み戻しに失敗した場合に発生します。また、自身が読み込み用にオープンされていない時、自身がまだ一度も read されていない時に発生します。

write(str) -> Integer

IOポートに対して str を出力します。str が文字列でなければ to_s による文字列化を試みます。実際に出力できたバイト数を返します。

IO#syswrite を除く全ての出力メソッドは、最終的に "write" という名のメソッドを呼び出すので、このメソッドを置き換えることで出力関数の挙動を変更することができます。

[PARAM] str:: 自身に書き込みたい文字列を指定します。
[EXCEPTION] IOError:: 自身が書き込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: 出力に失敗した場合に発生します。

write_nonblock(string) -> Integer

IO をノンブロッキングモードに設定し、string を write(2) システムコールで書き出します。

write(2) が成功した場合、書き込んだ長さを返します。 EAGAIN, EINTR などは例外 Errno::EXXX として呼出元に報告されます。書き込んだバイト数(つまり返り値)は String#bytesize の値より小さい可能性があります。

発生した例外がErrno::EAGAIN、 Errno::EWOULDBLOCK である場合は、その例外オブジェクトに IO::WaitWritable が Object#extend されます。よって IO::WaitWritable を write_nonblock のリトライが必要かの判定に用いることができます。

[PARAM] string:: 自身に書き込みたい文字列を指定します。
[EXCEPTION] IOError:: 自身が書き込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: write(2) が失敗した場合に発生します。

定数

SEEK_CUR -> Fixnum: IO#seek を参照してください。
SEEK_END -> Fixnum: IO#seek を参照してください。
SEEK_SET -> Fixnum: IO#seek を参照してください。

class UNIXServer

Ruby 1.9.3 リファレンスマニュアル
- はじめに
- コマンド
- Rubyの起動
- 環境変数
- Ruby言語仕様
- 組み込みライブラリ
- 標準添付ライブラリ
  - CUI
    - curses
    - expect
    - io/console
    - pty
    - readline
    - shell
  - 文字コード
    - iconv
    - kconv
    - nkf
  - コマンドライン
    - getoptlong
    - optparse
  - データベース
    - dbm
    - gdbm
    - pstore
    - sdbm
  - 日付・時間
    - date
    - time
  - デザインパターン
  - 開発
    - benchmark
    - coverage
    - debug
    - irb
    - minitest/mock
    - minitest/spec
    - minitest/unit
    - mkmf
    - pp
    - profile
    - profiler
    - rake
    - rbconfig
    - test/unit
    - tracer
  - ファイル
    - fileutils
    - find
    - pathname
    - tempfile
    - tmpdir
    - un
  - ファイルフォーマット
    - csv
    - json
    - psych
    - rdoc
    - rexml
    - rss
    - syck
    - yaml
    - zlib
  - GC
    - weakref
  - GUI
    - tk
  - 入出力
    - fcntl
    - io/nonblock
    - io/wait
    - open3
    - scanf
  - 数学
    - bigdecimal
    - cmath
    - complex
    - mathn
    - matrix
    - prime
    - rational
    - set
    - tsort
  - ネットワーク
    - cgi
    - drb
    - gserver
    - ipaddr
    - net/ftp
    - net/http
    - net/https
    - net/imap
    - net/pop
    - net/protocol
    - net/smtp
    - net/telnet
    - open-uri
    - openssl
    - resolv
    - resolv-replace
    - socket
    - uri
    - webrick
    - xmlrpc
  - テキスト
    - digest
    - erb
    - ripper
    - shellwords
    - stringio
    - strscan
  - スレッド
    - monitor
    - mutex_m
    - sync
    - thread
    - thwait
    - timeout
  - Unix
    - etc
    - syslog
  - Windows
  - その他
    - abbrev
    - base64
    - continuation
    - dl
    - e2mmap
    - English
    - fiber
    - logger
    - objspace
    - ostruct
    - prettyprint
    - racc/parser
    - rinda/rinda
    - rinda/tuplespace
    - rubygems
    - securerandom
    - ubygems
- pack テンプレート文字列
- sprintf フォーマット
- Ruby用語集
- Rubyで使われる記号の意味
- 疑似BNFによるRubyの文法
- バージョン情報 / このリファレンスについて