Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 29 additions & 0 deletions doc/stringio/getbyte.rdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Reads and returns the next integer byte (not character) from the stream:

s = 'foo'
s.bytes # => [102, 111, 111]
strio = StringIO.new(s)
strio.getbyte # => 102
strio.getbyte # => 111
strio.getbyte # => 111

Returns +nil+ if at end-of-stream:

strio.eof? # => true
strio.getbyte # => nil

Returns a byte, not a character:

s = 'тест'
s.bytes # => [209, 130, 208, 181, 209, 129, 209, 130]
strio = StringIO.new(s)
strio.getbyte # => 209
strio.getbyte # => 130

s = 'こんにちは'
s.bytes # => [227, 129, 147, 227, 130, 147, 227, 129, 171, 227, 129, 161, 227, 129, 175]
strio = StringIO.new(s)
strio.getbyte # => 227
strio.getbyte # => 129

Related: StringIO.getc.
6 changes: 3 additions & 3 deletions ext/stringio/stringio.c
Original file line number Diff line number Diff line change
Expand Up @@ -982,10 +982,10 @@ strio_getc(VALUE self)

/*
* call-seq:
* getbyte -> byte or nil
* getbyte -> integer or nil
*
* :include: stringio/getbyte.rdoc
*
* Reads and returns the next 8-bit byte from the stream;
* see {Byte IO}[rdoc-ref:IO@Byte+IO].
*/
static VALUE
strio_getbyte(VALUE self)
Expand Down
Loading