Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Ruby3.x】StringIO::eof()メソッドの使い方

eofメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

eofメソッドは、StringIOオブジェクトがファイル終端に達しているかを判定するメソッドです。StringIOクラスは、メモリ上の文字列データをあたかもディスク上のファイルのように読み書きするためのクラスで、文字列に対してファイルI/Oの操作を行いたい場合に非常に便利です。このeofメソッドは、StringIOオブジェクトが内部で保持している文字列の現在の読み取り位置が、データの終端に到達しているかどうかをチェックするために使用されます。

具体的には、読み取りポインタが文字列データの末尾に達しており、これ以上読み取れるデータがない場合にtrueを返します。逆に、まだ読み取ることが可能なデータが残っている場合にはfalseを返します。この機能は、StringIOオブジェクトからデータを順次読み込むループ処理などで、データの終端に到達したことを検知し、読み取り処理を適切に終了させるための条件判定に不可欠です。

例えば、StringIOから一行ずつデータを読み取るプログラムにおいて、次に読み取るべきデータがあるかを確認するためにeofメソッドを利用することで、不要な読み取り試行を防ぎ、処理を安全に進めることができます。また、eof?というエイリアス(別名)メソッドも同じ機能を提供します。これにより、メモリ上の文字列データに対するファイルの終端検知という概念を、プログラムで効率的に扱うことが可能となります。

構文(syntax)

1require 'stringio'
2
3str_io = StringIO.new("Hello, Ruby!")
4
5# データを一部読み込む
6str_io.read(6)
7
8# まだ終端ではないため、false を返す
9str_io.eof? # => false
10
11# 残りのデータをすべて読み込む
12str_io.read
13
14# すべて読み込んだため、終端に達し、true を返す
15str_io.eof? # => true

引数(parameters)

引数なし

引数はありません

戻り値(return)

Boolean

StringIOオブジェクトの現在位置が、データストリームの末尾に達しているかどうかを示します。達していれば真(true)を、達していなければ偽(false)を返します。

関連コンテンツ

関連プログラミング言語