From be495013a798891945669f940301bd9914d1519d Mon Sep 17 00:00:00 2001 From: Burdette Lamar Date: Mon, 3 Nov 2025 18:58:37 -0600 Subject: [PATCH] [ruby/stringio] [DOC] Doc for StringIO#getbyte (https://github.com/ruby/stringio/pull/162) https://github.com/ruby/stringio/commit/95a7dd592c --- doc/stringio/getbyte.rdoc | 29 +++++++++++++++++++++++++++++ ext/stringio/stringio.c | 6 +++--- 2 files changed, 32 insertions(+), 3 deletions(-) create mode 100644 doc/stringio/getbyte.rdoc diff --git a/doc/stringio/getbyte.rdoc b/doc/stringio/getbyte.rdoc new file mode 100644 index 0000000000..48c334b525 --- /dev/null +++ b/doc/stringio/getbyte.rdoc @@ -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. diff --git a/ext/stringio/stringio.c b/ext/stringio/stringio.c index cf3e06a71f..5f8dc047e8 100644 --- a/ext/stringio/stringio.c +++ b/ext/stringio/stringio.c @@ -990,10 +990,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)