Skip to content

[DOC] Tweaks for StringIO#eof? #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kou merged 1 commit into from
Nov 4, 2025
Merged

[DOC] Tweaks for StringIO#eof? #160

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions ext/stringio/stringio.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -699,10 +699,18 @@ strio_to_read(VALUE self)
* call-seq:
* eof? -> true or false
*
* Returns +true+ if positioned at end-of-stream, +false+ otherwise;
* see {Position}[rdoc-ref:IO@Position].
* Returns whether +self+ is positioned at end-of-stream:
*
* strio = StringIO.new('foo')
* strio.pos # => 0
* strio.eof? # => false
* strio.read # => "foo"
* strio.pos # => 3
* strio.eof? # => true
* strio.close_read
* strio.eof? # Raises IOError: not opened for reading
*
* Raises IOError if the stream is not opened for reading.
* Related: StringIO#pos.
*/
static VALUE
strio_eof(VALUE self)
Expand Down
Loading