IO クラス

　　基本的な入出力を扱うクラスです．なお，以下の説明において，ファイル file1 の内容は: data1 in file1; data2 in file1
であるとします．

［インクルードモジュール］ Enumerable モジュール File::Constants モジュール
［クラスメソッド］ IO.new　IO オブジェクトの生成 IO.for_fd　IO オブジェクトの生成 IO.open　IO オブジェクトの生成 IO.foreach　ファイルの各行に対する処理の繰り返し IO.read　バイト単位入力 IO.readlines　ファイルの各行を要素としてもつ配列 IO.sysopen　ファイルのオープン
［メソッド］ <<　オブジェクトの出力 close　ポートを閉じる close_read　入力ポートを閉じる close_write　出力ポートを閉じる closed?　ポートが閉じられているか？ each　1 行ずつ入力処理 each_line　1 行ずつ入力処理 each_byte　1 バイトずつ入力処理 eof　ファイルの終端か？ eof?　ファイルの終端か？ fileno　ファイルディスクリプタ to_i　ファイルディスクリプタ flush　書き込み用内部バッファをフラッシュ getc　1 バイト入力 gets　1 行入力 lineno　行番号の参照と設定 pos　ファイルポインタの位置の参照と設定 tell　ファイルポインタの位置の参照と設定 print　引数の出力 printf　引数をフォーマットして出力 putc　1 文字出力 puts　引数を順に出力し，改行 read　指定バイトの読み込み readlines　全データを読み込み，配列として返す reopen　再オープン rewind　ファイルポインタを先頭へ移動 seek　ファイルポインタの移動 ungetc　1 文字だけ読み戻す write　文字列の出力

［クラスメソッド］

IO.new ( fd [ , mode ] )
IO.for_fd ( fd [ , mode ] )
IO.open ( fd [ , mode ] )
IO.open ( fd [ , mode ] ) { |io| ･･･ }

　　オープン済みのファイルディスクリプタ fd に対して，新しい IO オブジェクトを生成して返します．ただし，ブロックつき IO.open は，ブロックの結果を返します．mode の詳細は，組み込み関数 open を参照してください．mode のデフォルト値は "r" です．

fd = IO.sysopen("file1")

io = IO.new(fd, "r")

p io.gets # => "data1 in file1\n"
IO.foreach ( path [ , rs ] ) { |line| ･･･ }

　　path で指定されたファイルの各行に対して，ブロック内の処理を繰り返します．path のオープンに成功すれば，nil を返します．失敗した場合は例外 Errno::EXXX が発生します．

　　行の区切りは，引数 rs で指定した文字列になります．rs のデフォルト値は，組み込み変数 $/ の値（デフォルトは nil ）です．

　　rs に nil を指定すると，行区切りなしとみなします．空文字列 "" を指定すると，連続する改行を行の区切りとみなします（パラグラフモード）．
```
IO.foreach("file1") { |line| p line }
p IO.readlines("file1")
		
```
（出力）
```
"data1 in file1\n"
"data2 in file1\n"
["data1 in file1\n", "data2 in file1\n"]
		
```
IO.read ( path, [ length, [ offset ] ] )

　　path で指定されたファイルを，offset 位置から length バイト分読み込んで返します．length が nil であるか，または，省略した場合には，EOF まで読み込みます．

p IO.read("file1", 5, 0) # => "data1"
IO.readlines ( path [ , rs ] )

　　path で指定されたファイルを全て読み込んで，その各行を要素としてもつ配列を返します．IO が既に EOF に達していれば，空配列 [] を返します．

　　行の区切りは，引数 rs で指定した文字列になります．rs のデフォルト値は，組み込み変数 $/ の値（デフォルトは nil ）です．

　　rs に nil を指定すると，行区切りなしとみなします．空文字列 "" を指定すると，連続する改行を行の区切りとみなします（パラグラフモード）．
```
IO.foreach("file1") { |line| p line }
p IO.readlines("file1")
		
```
（出力）
```
"data1 in file1\n"
"data2 in file1\n"
["data1 in file1\n", "data2 in file1\n"]
		
```
IO.sysopen ( path [ , mode [ , perm ] ] )

　　pathで指定されるファイルをオープンし，ファイルディスクリプタを返します．mode，及び，perm の詳細は，組み込み関数 open を参照してください．

fd = IO.sysopen("file1")

io = IO.new(fd, "r")

p io.gets # => "data1 in file1\n"

［メソッド］

self << object

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

x = 10 + 20

$stdout << "結果は " << x << " です" # => 結果は 30 です
close

　　入出力ポートをクローズします．nil を返します．

io = File.open("file1", "r")

p io.gets # => "data1 in file1\n"

io.close
close_read
　　読み込み用の IO を close します．nil を返します．
close_write
　　書き込み用の IO を close します．nil を返します．
closed?

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

each ( [ rs ] ) { | line | ･･･ }
each_line ( [ rs ] ) { | line | ･･･ }

　　IO ポートから 1 行ずつ読み込んで，処理を繰り返すイテレータです．self を返します．行の区切りは，引数 rs で指定した文字列になります．rs のデフォルト値は，組み込み変数 $/ の値（デフォルトは \n ）です．

　　rs に nil を指定すると，行区切りなしとみなします．空文字列 "" を指定すると，連続する改行を行の区切りとみなします（パラグラフモード）．
io = File.open("file1", "r") io.each { |line| p line } io.close

（出力）
"data1 in file1\n" "data2 in file1\n"

each_byte { | ch | ･･･ }

　　IO ポートから 1 バイトずつ読み込みます．self を返します．

str = ""

io = File.open("file1", "r")

io.each_byte { |ch| str << ch }

p str # => "data1 in file1\ndata2 in file1\n"

io.close

eof
eof?

　　ストリームがファイルの終端に達した場合，真を返します．

fileno
to_i

　　ファイルディスクリプタの番号を返します．

p $stdin.fileno # => 0

p $stdout.fileno # => 1

p $stderr.fileno # => 2

flush

　　IO ポートの書き込み用内部バッファをフラッシュします．self を返します．

getc

　　IO ポートから 1 バイト読み込んで，その文字に対応する Fixnum を返します．EOF に到達した時には，nil を返します．
str = "" io = File.open("file1", "r") while ch = io.getc str << ch end p str # "data1 in file1\ndata2 in file1\n" を出力 io.close

gets ( [ rs ] )

　　1 行読み込んで，読み込みに成功した時には，その文字列を返します．ファイルの終りに到達した時には，nil を返します．行の区切りは，引数 rs で指定した文字列になります．rs のデフォルト値は，組み込み変数 $/ の値（デフォルトは \n ）です．

　　rs に nil を指定すると，行区切りなしとみなします．空文字列 "" を指定すると，連続する改行を行の区切りとみなします（パラグラフモード）．
io = File.open("file1", "r") while line = io.gets p line end io.close

（出力）
"data1 in file1\n" "data2 in file1\n"

lineno
lineno = number

　　現在の行番号を返します．行番号を設定することも可能です．設定しない場合は，1 から始まります．
io = File.open("file1", "r") io.lineno = 10 while line = io.gets print io.lineno, " ", line end io.close

（出力）
11 data1 in file1 12 data2 in file1

pos
pos = n
tell

　　ファイルポインタの現在の位置を返します．また，pos を使用して，指定位置に移動することも可能です（ seek 参照）．
str = "" io = File.open("file1", "r") io.pos = 16 while ch = io.gets str << ch end p str # "data2 in file1\n" を出力 io.close

print ( [ arg [ , ･･･ ] ] )

　　引数を IO ポートに順に出力します．引数を省略した場合は，組み込み変数 $_ の内容を出力します．引数の扱いは，組み込み関数 print と同じです．nil を返します．
inp = File.open("file1", "r") out = File.open("file2", "w") while line = inp.gets line = line.chomp # 改行を取り除く out.print(inp.lineno, " ", line, "\n") end inp.close out.close

（出力）
1 data1 in file1 2 data2 in file1

printf ( format [ , arg [ , ･･･ ] ] )

　　C 言語の printf と同じように，format に従い，引数を文字列に変換して出力します．第一引数に IO を指定できないこと，引数を省略できないことを除けば，組み込み関数 printf と同じです．nil を返します．
inp = File.open("file1", "r") out = File.open("file2", "w") while line = inp.gets line = line.chomp # 改行を取り除く out.printf("%2d %s\n", inp.lineno, line) end inp.close out.close

（出力）
1 data1 in file1 2 data2 in file1

putc ( ch )

　　文字 ch を出力します．引数の扱いは，組み込み関数 putc と同じです．ch を返します．
inp = File.open("file1", "r") out = File.open("file2", "w") while ch = inp.getc out.putc ch end inp.close out.close

（出力）
data1 in file1 data2 in file1

puts ( [obj [ , ･･･ ] ] )

　　各 obj を出力した後，改行します（改行が既に存在する場合は，改行しない）．引数の扱いは，組み込み関数 puts と同じです．nil を返します．
inp = File.open("file1", "r") out = File.open("file2", "w") while line = inp.gets out.puts(line, line) end inp.close out.close

（出力）
data1 in file1 data1 in file1 data2 in file1 data2 in file1

read ( [ length [ , buf ] ] )

　　length が指定された場合，length バイト読み込んで、その文字列を返します．IO が既に EOF に達していれば nil を返します．length が省略された時には，EOF までの全てのデータを読み込みます．

　　第二引数として文字列を指定すると，読み込んだデータをその文字列オブジェクトに上書きして返します．第二引数を指定した read の呼び出しにおいて，データが空であった場合（ read が nil を返す場合），buf は空文字列になります．

inp = File.open("file1", "r")

p inp.read() # => "data1 in file1\ndata2 in file1\n"

inp.pos = 0

p inp.read(10) # => "data1 in f"

inp.pos = 0

buf = ""

p inp.read(10, buf) # => "data1 in f"

p buf # => "data1 in f"

inp.close

readlines ( [ rs ] )

　　データを全て読み込んで，その各行を要素としてもつ配列を返します．IO が既に EOF に達していれば，空配列 [] を返します．行の区切りは，引数 rs で指定した文字列になります．rs のデフォルト値は，組み込み変数 $/ の値（デフォルトは \n ）です．

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

inp = File.open("file1", "r")

p inp.readlines # => ["data1 in file1\n", "data2 in file1\n"]

inp.close

reopen ( io )
reopen ( name [ , mode ] )

　　自身を io に繋ぎ換えます．第一引数が文字列の時，name で指定されたファイルにストリームを繋ぎ換えます．第二引数のデフォルト値は r であり，省略したときは，self のモードをそのまま引き継ぎます．self を返します．

　　下に示すプログラムは，標準出力を file2，及び，標準エラー出力を file3 に変更した例です．その下に示すのが出力結果であり，1 行目は file2，それ以外は file3 の内容を表しています．
out = File.open("file2", "w") $stdout.reopen(out) $stderr.reopen("file3", "w") x = 5 while x >= 0 y = 10 / x printf("%3d", y) x -= 1 end out.close

（出力）
2 2 3 5 10 test.rb:6:in `/': divided by 0 (ZeroDivisionError) from test.rb:6

rewind

　　ファイルポインタを先頭に移動します．lineno も 0 に戻ります．
io = File.open("file1", "r") while line = io.gets print io.lineno, " ", line end io.rewind while line = io.gets print io.lineno, " ", line end io.close

（出力）
1 data1 in file1 2 data2 in file1 1 data1 in file1 2 data2 in file1

seek ( offset [ , whence ] )

　　ファイルポインタを，whence の位置から，offset だけ移動させます（ pos 参照）．whence の値は，以下のいずれかです．

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

　　offset 位置への移動が成功すれば，0 を返します．失敗した場合は例外 Errno::EXXX が発生します．
io = File.open("file1", "r") while line = io.gets print io.lineno, " ", line end io.seek(0, IO::SEEK_SET) # io.pos = 0 と同じ while line = io.gets print io.lineno, " ", line end io.close

（出力）
1 data1 in file1 2 data2 in file1 3 data1 in file1 4 data2 in file1

ungetc ( char )

　　char を読み戻します．2 バイト以上の読み戻しは保証されません．nil を返します．

io = File.open("file1", "r")

str = ""

ch = io.getc

str << ch

ch = io.getc

str << ch

io.ungetc(ch)

ch = io.getc

str << ch

p str # => "daa"

io.close

write ( str )

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

io = File.open("file2", "w")

p io.write("abc") # => 3 （ file2 には abc ）

io.close

静岡理工科大学

菅沼ホーム

Ruby 目次

索引