rbs 3.0.0.dev.2 → 3.0.0.dev.3

data/core/string_io.rbs

@@ -1,39 +1,52 @@
 # <!-- rdoc-file=ext/stringio/stringio.c -->
-# Pseudo I/O on String object, with interface corresponding to IO.
+# IO streams for strings, with access similar to [IO](rdoc-ref:IO); see
+# [IO](rdoc-ref:IO).
 #
-# Commonly used to simulate `$stdio` or `$stderr`
+# ### About the Examples
 #
-# ### Examples
+# Examples on this page assume that StringIO has been required:
 #
 #     require 'stringio'
 #
-#     # Writing stream emulation
-#     io = StringIO.new
-#     io.puts "Hello World"
-#     io.string #=> "Hello World\n"
-#
-#     # Reading stream emulation
-#     io = StringIO.new "first\nsecond\nlast\n"
-#     io.getc #=> "f"
-#     io.gets #=> "irst\n"
-#     io.read #=> "second\nlast\n"
-#
 class StringIO
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - StringIO.new(string=""[, mode])
+  #   - StringIO.new(string = '', mode = 'r+') -> new_stringio
   # -->
-  # Creates new StringIO instance from with *string* and *mode*.
+  # Note that `mode` defaults to `'r'` if `string` is frozen.
+  #
+  # Returns a new StringIO instance formed from `string` and `mode`; see [Access
+  # Modes](rdoc-ref:File@Access+Modes):
+  #
+  #     strio = StringIO.new # => #<StringIO>
+  #     strio.close
+  #
+  # The instance should be closed when no longer needed.
+  #
+  # Related: StringIO.open (accepts block; closes automatically).
   #
   def initialize: (?String string, ?String? mode) -> void
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - StringIO.open(string=""[, mode]) {|strio| ...}
+  #   - StringIO.open(string = '', mode = 'r+') {|strio| ... }
   # -->
-  # Equivalent to StringIO.new except that when it is called with a block, it
-  # yields with the new instance and closes it, and returns the result which
-  # returned from the block.
+  # Note that `mode` defaults to `'r'` if `string` is frozen.
+  #
+  # Creates a new StringIO instance formed from `string` and `mode`; see [Access
+  # Modes](rdoc-ref:File@Access+Modes).
+  #
+  # With no block, returns the new instance:
+  #
+  #     strio = StringIO.open # => #<StringIO>
+  #
+  # With a block, calls the block with the new instance and returns the block's
+  # value; closes the instance on block exit.
+  #
+  #     StringIO.open {|strio| p strio }
+  #     # => #<StringIO>
+  #
+  # Related: StringIO.new.
   #
   def self.open: [U] (?String string, ?String? mode) { (StringIO arg) -> U } -> U
 
@@ -41,116 +54,134 @@ class StringIO
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.binmode    -> stringio
+  #   - binmode -> self
   # -->
-  # Puts stream into binary mode. See IO#binmode.
+  # Sets the data mode in `self` to binary mode; see [Data
+  # Mode](rdoc-ref:File@Data+Mode).
   #
   def binmode: () -> self
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.close  -> nil
+  #   - close -> nil
   # -->
-  # Closes a StringIO. The stream is unavailable for any further data operations;
-  # an `IOError` is raised if such an attempt is made.
+  # Closes `self` for both reading and writing.
+  #
+  # Raises IOError if reading or writing is attempted.
+  #
+  # Related: StringIO#close_read, StringIO#close_write.
   #
   def close: () -> nil
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.close_read    -> nil
+  #   - close_read -> nil
   # -->
-  # Closes the read end of a StringIO.  Will raise an `IOError` if the receiver is
-  # not readable.
+  # Closes `self` for reading; closed-write setting remains unchanged.
+  #
+  # Raises IOError if reading is attempted.
+  #
+  # Related: StringIO#close, StringIO#close_write.
   #
   def close_read: () -> nil
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.close_write    -> nil
+  #   - close_write -> nil
   # -->
-  # Closes the write end of a StringIO.  Will raise an  `IOError` if the receiver
-  # is not writeable.
+  # Closes `self` for writing; closed-read setting remains unchanged.
+  #
+  # Raises IOError if writing is attempted.
+  #
+  # Related: StringIO#close, StringIO#close_read.
   #
   def close_write: () -> nil
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.closed?    -> true or false
+  #   - closed? -> true or false
   # -->
-  # Returns `true` if the stream is completely closed, `false` otherwise.
+  # Returns `true` if `self` is closed for both reading and writing, `false`
+  # otherwise.
   #
   def closed?: () -> bool
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.closed_read?    -> true or false
+  #   - closed_read? -> true or false
   # -->
-  # Returns `true` if the stream is not readable, `false` otherwise.
+  # Returns `true` if `self` is closed for reading, `false` otherwise.
   #
   def closed_read?: () -> bool
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.closed_write?    -> true or false
+  #   - closed_write? -> true or false
   # -->
-  # Returns `true` if the stream is not writable, `false` otherwise.
+  # Returns `true` if `self` is closed for writing, `false` otherwise.
   #
   def closed_write?: () -> bool
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.each(sep=$/, chomp: false) {|line| block }         -> strio
-  #   - strio.each(limit, chomp: false) {|line| block }          -> strio
-  #   - strio.each(sep, limit, chomp: false) {|line| block }     -> strio
-  #   - strio.each(...)                                          -> anEnumerator
-  #   - strio.each_line(sep=$/, chomp: false) {|line| block }     -> strio
-  #   - strio.each_line(limit, chomp: false) {|line| block }      -> strio
-  #   - strio.each_line(sep, limit, chomp: false) {|line| block } -> strio
-  #   - strio.each_line(...)                                      -> anEnumerator
+  #   - each_line(sep = $/, chomp: false) {|line| ... }   -> self
+  #   - each_line(limit, chomp: false) {|line| ... }      -> self
+  #   - each_line(sep, limit, chomp: false) {|line| ... } -> self
   # -->
-  # See IO#each.
+  # Calls the block with each remaining line read from the stream; does nothing if
+  # already at end-of-file; returns `self`. See [Line IO](rdoc-ref:IO@Line+IO).
+  #
+  # StringIO#each is an alias for StringIO#each_line.
   #
   def each: (?String sep, ?Integer limit, ?chomp: boolish) { (String) -> untyped } -> self
           | (?String sep, ?Integer limit, ?chomp: boolish) -> ::Enumerator[String, self]
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.each_byte {|byte| block }  -> strio
-  #   - strio.each_byte                  -> anEnumerator
+  #   - each_byte {|byte| ... } -> self
   # -->
-  # See IO#each_byte.
+  # With a block given, calls the block with each remaining byte in the stream;
+  # see [Byte IO](rdoc-ref:IO@Byte+IO).
+  #
+  # With no block given, returns an enumerator.
   #
   def each_byte: () { (Integer arg0) -> untyped } -> self
                | () -> ::Enumerator[Integer, self]
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.each_char {|char| block }  -> strio
-  #   - strio.each_char                  -> anEnumerator
+  #   - each_char {|c| ... } -> self
   # -->
-  # See IO#each_char.
+  # With a block given, calls the block with each remaining character in the
+  # stream; see [Character IO](rdoc-ref:IO@Character+IO).
+  #
+  # With no block given, returns an enumerator.
   #
   def each_char: () { (String arg0) -> untyped } -> self
                | () -> ::Enumerator[String, self]
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.each_codepoint {|c| block }  -> strio
-  #   - strio.each_codepoint               -> anEnumerator
+  #   - each_codepoint {|codepoint| ... } -> self
   # -->
-  # See IO#each_codepoint.
+  # With a block given, calls the block with each remaining codepoint in the
+  # stream; see [Codepoint IO](rdoc-ref:IO@Codepoint+IO).
+  #
+  # With no block given, returns an enumerator.
   #
   def each_codepoint: () { (Integer arg0) -> untyped } -> self
                     | () -> ::Enumerator[Integer, self]
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.eof     -> true or false
-  #   - strio.eof?    -> true or false
+  #   - eof? -> true or false
   # -->
-  # Returns true if the stream is at the end of the data (underlying string). The
-  # stream must be opened for reading or an `IOError` will be raised.
+  # Returns `true` if positioned at end-of-stream, `false` otherwise; see
+  # [Position](rdoc-ref:File@Position).
+  #
+  # Raises IOError if the stream is not opened for reading.
+  #
+  # StreamIO#eof is an alias for StreamIO#eof?.
   #
   def eof: () -> bool
 
@@ -188,27 +219,30 @@ class StringIO
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.getbyte   -> fixnum or nil
+  #   - getbyte -> byte or nil
   # -->
-  # See IO#getbyte.
+  # Reads and returns the next 8-bit byte from the stream; see [Byte
+  # IO](rdoc-ref:IO@Byte+IO).
   #
   def getbyte: () -> Integer?
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.getc   -> string or nil
+  #   - getc -> character or nil
   # -->
-  # See IO#getc.
+  # Reads and returns the next character from the stream; see [Character
+  # IO](rdoc-ref:IO@Character+IO).
   #
   def getc: () -> String?
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.gets(sep=$/, chomp: false)     -> string or nil
-  #   - strio.gets(limit, chomp: false)      -> string or nil
-  #   - strio.gets(sep, limit, chomp: false) -> string or nil
+  #   - gets(sep = $/, chomp: false) -> string or nil
+  #   - gets(limit, chomp: false) -> string or nil
+  #   - gets(sep, limit, chomp: false) -> string or nil
   # -->
-  # See IO#gets.
+  # Reads and returns a line from the stream; assigns the return value to `$_`;
+  # see [Line IO](rdoc-ref:IO@Line+IO).
   #
   def gets: (?String sep, ?Integer limit, ?chomp: boolish) -> String?
 
@@ -240,21 +274,19 @@ class StringIO
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.lineno    -> integer
+  #   - lineno -> current_line_number
   # -->
-  # Returns the current line number. The stream must be opened for reading.
-  # `lineno` counts the number of times  `gets` is called, rather than the number
-  # of newlines  encountered. The two values will differ if `gets` is  called with
-  # a separator other than newline.  See also the  `$.` variable.
+  # Returns the current line number in `self`; see [Line
+  # Number](rdoc-ref:IO@Line+Number).
   #
   def lineno: () -> Integer
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.lineno = integer    -> integer
+  #   - lineno = new_line_number -> new_line_number
   # -->
-  # Manually sets the current line number to the given value. `$.` is updated only
-  # on the next read.
+  # Sets the current line number in `self` to the given `new_line_number`; see
+  # [Line Number](rdoc-ref:IO@Line+Number).
   #
   def lineno=: (Integer arg0) -> Integer
 
@@ -268,18 +300,19 @@ class StringIO
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.pos     -> integer
-  #   - strio.tell    -> integer
+  #   - pos -> stream_position
   # -->
-  # Returns the current offset (in bytes).
+  # Returns the current position (in bytes); see [Position](rdoc-ref:IO@Position).
+  #
+  # StringIO#tell is an alias for StringIO#pos.
   #
   def pos: () -> Integer
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.pos = integer    -> integer
+  #   - pos = new_position -> new_position
   # -->
-  # Seeks to the given position (in bytes).
+  # Sets the current position (in bytes); see [Position](rdoc-ref:IO@Position).
   #
   def pos=: (Integer arg0) -> Integer
 
@@ -327,29 +360,45 @@ class StringIO
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.reopen(other_StrIO)     -> strio
-  #   - strio.reopen(string, mode)    -> strio
+  #   - reopen(other, mode = 'r+') -> self
   # -->
-  # Reinitializes the stream with the given *other_StrIO* or *string* and *mode*
-  # (see StringIO#new).
+  # Reinitializes the stream with the given `other` (string or StringIO) and
+  # `mode`; see IO.new:
+  #
+  #     StringIO.open('foo') do |strio|
+  #       p strio.string
+  #       strio.reopen('bar')
+  #       p strio.string
+  #       other_strio = StringIO.new('baz')
+  #       strio.reopen(other_strio)
+  #       p strio.string
+  #       other_strio.close
+  #     end
+  #
+  # Output:
+  #
+  #     "foo"
+  #     "bar"
+  #     "baz"
   #
   def reopen: (StringIO other) -> self
             | (String other, ?String mode_str) -> self
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.rewind    -> 0
+  #   - rewind -> 0
   # -->
-  # Positions the stream to the beginning of input, resetting `lineno` to zero.
+  # Sets the current position and line number to zero; see
+  # [Position](rdoc-ref:IO@Position) and [Line Number](rdoc-ref:IO@Line+Number).
   #
   def rewind: () -> Integer
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.seek(amount, whence=SEEK_SET) -> 0
+  #   - seek(offset, whence = SEEK_SET) -> 0
   # -->
-  # Seeks to a given offset *amount* in the stream according to the value of
-  # *whence* (see IO#seek).
+  # Sets the current position to the given integer `offset` (in bytes), with
+  # respect to a given constant `whence`; see [Position](rdoc-ref:IO@Position).
   #
   def seek: (Integer amount, ?Integer whence) -> Integer
 
@@ -366,17 +415,44 @@ class StringIO
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.string     -> string
+  #   - string -> string
   # -->
-  # Returns underlying String object, the subject of IO.
+  # Returns underlying string:
+  #
+  #     StringIO.open('foo') do |strio|
+  #       p strio.string
+  #       strio.string = 'bar'
+  #       p strio.string
+  #     end
+  #
+  # Output:
+  #
+  #     "foo"
+  #     "bar"
+  #
+  # Related: StringIO#string= (assigns the underlying string).
   #
   def string: () -> String
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.string = string  -> string
+  #   - string = other_string -> other_string
   # -->
-  # Changes underlying String object, the subject of IO.
+  # Assigns the underlying string as `other_string`, and sets position to zero;
+  # returns `other_string`:
+  #
+  #     StringIO.open('foo') do |strio|
+  #       p strio.string
+  #       strio.string = 'bar'
+  #       p strio.string
+  #     end
+  #
+  # Output:
+  #
+  #     "foo"
+  #     "bar"
+  #
+  # Related: StringIO#string (returns the underlying string).
   #
   def string=: (String str) -> String
 
@@ -391,9 +467,9 @@ class StringIO
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.sync    -> true
+  #   - sync -> true
   # -->
-  # Returns `true` always.
+  # Returns `true`; implemented only for compatibility with other stream classes.
   #
   def sync: () -> bool
 
@@ -411,10 +487,11 @@ class StringIO
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.pos     -> integer
-  #   - strio.tell    -> integer
+  #   - pos -> stream_position
   # -->
-  # Returns the current offset (in bytes).
+  # Returns the current position (in bytes); see [Position](rdoc-ref:IO@Position).
+  #
+  # StringIO#tell is an alias for StringIO#pos.
   #
   def tell: () -> Integer
 
@@ -425,19 +502,19 @@ class StringIO
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.ungetbyte(fixnum)   -> nil
+  #   - ungetbyte(byte) -> nil
   # -->
-  # See IO#ungetbyte
+  # Pushes back ("unshifts") an 8-bit byte onto the stream; see [Byte
+  # IO](rdoc-ref:IO@Byte+IO).
   #
   def ungetbyte: (String | Integer arg0) -> nil
 
   # <!--
   #   rdoc-file=ext/stringio/stringio.c
-  #   - strio.ungetc(string)   -> nil
+  #   - ungetc(character) -> nil
   # -->
-  # Pushes back one character (passed as a parameter) such that a subsequent
-  # buffered read will return it.  There is no limitation for multiple pushbacks
-  # including pushing back behind the beginning of the buffer string.
+  # Pushes back ("unshifts") a character or integer onto the stream; see
+  # [Character IO](rdoc-ref:IO@Character+IO).
   #
   def ungetc: (String arg0) -> nil
 
@@ -468,14 +545,21 @@ class StringIO
                 | () -> ::Enumerator[Integer, self]
 
   # <!-- rdoc-file=ext/stringio/stringio.c -->
-  # See IO#each.
+  # Calls the block with each remaining line read from the stream; does nothing if
+  # already at end-of-file; returns `self`. See [Line IO](rdoc-ref:IO@Line+IO).
+  #
+  # StringIO#each is an alias for StringIO#each_line.
   #
   def each_line: (?String sep, ?Integer limit, ?chomp: boolish) { (String) -> untyped } -> self
                | (?String sep, ?Integer limit, ?chomp: boolish) -> ::Enumerator[String, self]
 
   # <!-- rdoc-file=ext/stringio/stringio.c -->
-  # Returns true if the stream is at the end of the data (underlying string). The
-  # stream must be opened for reading or an `IOError` will be raised.
+  # Returns `true` if positioned at end-of-stream, `false` otherwise; see
+  # [Position](rdoc-ref:File@Position).
+  #
+  # Raises IOError if the stream is not opened for reading.
+  #
+  # StreamIO#eof is an alias for StreamIO#eof?.
   #
   def eof?: () -> bool