rbs 3.9.5 → 3.10.0

data/core/enumerator.rbs

@@ -137,7 +137,7 @@ class Enumerator[unchecked out Elem, out Return = void] < Object
 
   # <!--
   #   rdoc-file=enumerator.c
-  #   - Enumerator.produce(initial = nil) { |prev| block } -> enumerator
+  #   - Enumerator.produce(initial = nil, size: nil) { |prev| block } -> enumerator
   # -->
   # Creates an infinite enumerator from any block, just called over and over.  The
   # result of the previous iteration is passed to the next one. If `initial` is
@@ -169,6 +169,23 @@ class Enumerator[unchecked out Elem, out Return = void] < Object
   #     Enumerator.produce { scanner.scan(PATTERN) }.slice_after { scanner.eos? }.first
   #     # => ["7", "+", "38", "/", "6"]
   #
+  # The optional `size` keyword argument specifies the size of the enumerator,
+  # which can be retrieved by Enumerator#size.  It can be an integer,
+  # `Float::INFINITY`, a callable object (such as a lambda), or `nil` to indicate
+  # unknown size.  When not specified, the size defaults to `Float::INFINITY`.
+  #
+  #     # Infinite enumerator
+  #     enum = Enumerator.produce(1, size: Float::INFINITY, &:succ)
+  #     enum.size  # => Float::INFINITY
+  #
+  #     # Finite enumerator with known/computable size
+  #     abs_dir = File.expand_path("./baz") # => "/foo/bar/baz"
+  #     traverser = Enumerator.produce(abs_dir, size: -> { abs_dir.count("/") + 1 }) {
+  #       raise StopIteration if it == "/"
+  #       File.dirname(it)
+  #     }
+  #     traverser.size  # => 4
+  #
   def self.produce: [T] () { (T? prev) -> T } -> Enumerator[T, bot]
                   | [T] (T initial) { (T prev) -> T } -> Enumerator[T, bot]
 

data/core/errno.rbs

@@ -38,6 +38,14 @@
 #     Errno::ENOENT::Errno      # => 2
 #     Errno::ENOTCAPABLE::Errno # => 0
 #
+# Each class in Errno can be created with optional messages:
+#
+#     Errno::EPIPE.new                  # => #<Errno::EPIPE: Broken pipe>
+#     Errno::EPIPE.new("foo")           # => #<Errno::EPIPE: Broken pipe - foo>
+#     Errno::EPIPE.new("foo", "here")   # => #<Errno::EPIPE: Broken pipe @ here - foo>
+#
+# See SystemCallError.new.
+#
 module Errno
   class NOERROR < SystemCallError
     Errno: 0

data/core/errors.rbs

@@ -302,9 +302,15 @@ class NameError[T] < StandardError
   def receiver: () -> T?
 end
 
+# <!-- rdoc-file=error.c -->
+# Raised when matching pattern not found.
+#
 class NoMatchingPatternError < StandardError
 end
 
+# <!-- rdoc-file=error.c -->
+# Raised when matching key not found.
+#
 class NoMatchingPatternKeyError[M, K] < NoMatchingPatternError
   # <!--
   #   rdoc-file=error.c
@@ -588,13 +594,34 @@ end
 class SystemCallError < StandardError
   # <!--
   #   rdoc-file=error.c
-  #   - SystemCallError.new(msg, errno)  -> system_call_error_subclass
+  #   - SystemCallError.new(msg, errno = nil, func = nil)  -> system_call_error_subclass
   # -->
   # If *errno* corresponds to a known system error code, constructs the
   # appropriate Errno class for that error, otherwise constructs a generic
   # SystemCallError object. The error number is subsequently available via the
   # #errno method.
   #
+  # If only numeric object is given, it is treated as an Integer *errno*, and
+  # *msg* is omitted, otherwise the first argument *msg* is used as the additional
+  # error message.
+  #
+  #     SystemCallError.new(Errno::EPIPE::Errno)
+  #     #=> #<Errno::EPIPE: Broken pipe>
+  #
+  #     SystemCallError.new("foo")
+  #     #=> #<SystemCallError: unknown error - foo>
+  #
+  #     SystemCallError.new("foo", Errno::EPIPE::Errno)
+  #     #=> #<Errno::EPIPE: Broken pipe - foo>
+  #
+  # If *func* is not `nil`, it is appended to the message with "` @ `".
+  #
+  #     SystemCallError.new("foo", Errno::EPIPE::Errno, "here")
+  #     #=> #<Errno::EPIPE: Broken pipe @ here - foo>
+  #
+  # A subclass of SystemCallError can also be instantiated via the `new` method of
+  # the subclass.  See Errno.
+  #
   def initialize: (string msg, Integer errno) -> void
 
   # <!--

data/core/exception.rbs

@@ -118,7 +118,7 @@ class Exception
   #       # String
   #     end
   #
-  # The value returned by this method migth be adjusted when raising (see
+  # The value returned by this method might be adjusted when raising (see
   # Kernel#raise), or during intermediate handling by #set_backtrace.
   #
   # See also #backtrace_locations that provide the same value, as structured
@@ -447,7 +447,7 @@ class Exception
   #     *   If the value of keyword `order` is `:top` (the default), lists the
   #         error message and the innermost backtrace entry first.
   #     *   If the value of keyword `order` is `:bottom`, lists the error message
-  #         the the innermost entry last.
+  #         the innermost entry last.
   #
   # Example:
   #

data/core/fiber.rbs

@@ -58,7 +58,7 @@
 # ## Non-blocking Fibers
 #
 # The concept of *non-blocking fiber* was introduced in Ruby 3.0. A non-blocking
-# fiber, when reaching a operation that would normally block the fiber (like
+# fiber, when reaching an operation that would normally block the fiber (like
 # `sleep`, or wait for another process or I/O) will yield control to other
 # fibers and allow the *scheduler* to handle blocking and waking up (resuming)
 # this fiber when it can proceed.
@@ -82,7 +82,8 @@ class Fiber < Object
   # -->
   # Returns the value of the fiber storage variable identified by `key`.
   #
-  # The `key` must be a symbol, and the value is set by Fiber#[]= or Fiber#store.
+  # The `key` must be a symbol, and the value is set by Fiber#[]= or
+  # Fiber#storage.
   #
   # See also Fiber::[]=.
   #
@@ -414,8 +415,8 @@ class Fiber < Object
   #
   # See Kernel#raise for more information.
   #
-  def raise: (?string msg) -> untyped
-           | (_Exception, ?string msg, ?Array[string] | Array[Thread::Backtrace::Location] | nil backtrace) -> untyped
+  def raise: (?string msg, ?cause: Exception?) -> untyped
+           | (_Exception, ?string msg, ?Array[string] | Array[Thread::Backtrace::Location] | nil backtrace, ?cause: Exception?) -> untyped
 
   # <!--
   #   rdoc-file=cont.c

data/core/file.rbs

@@ -1414,7 +1414,7 @@ class File < IO
   #   rdoc-file=file.c
   #   - File.owned?(file_name)   -> true or false
   # -->
-  # Returns `true` if the named file exists and the effective used id of the
+  # Returns `true` if the named file exists and the effective user id of the
   # calling process is the owner of the file.
   #
   # *file_name* can be an IO object.
@@ -1427,8 +1427,25 @@ class File < IO
   # -->
   # Returns the string representation of the path
   #
-  #     File.path(File::NULL)           #=> "/dev/null"
-  #     File.path(Pathname.new("/tmp")) #=> "/tmp"
+  #        File.path(File::NULL)           #=> "/dev/null"
+  #        File.path(Pathname.new("/tmp")) #=> "/tmp"
+  #
+  # If `path` is not a String:
+  #
+  # 1.  If it has the `to_path` method, that method will be called to coerce to a
+  #     String.
+  #
+  # 2.  Otherwise, or if the coerced result is not a String too, the standard
+  #     coersion using `to_str` method will take place on that object. (See also
+  #     String.try_convert)
+  #
+  # The coerced string must satisfy the following conditions:
+  #
+  # 1.  It must be in an ASCII-compatible encoding; otherwise, an
+  #     Encoding::CompatibilityError is raised.
+  #
+  # 2.  It must not contain the NUL character (`\0`); otherwise, an ArgumentError
+  #     is raised.
   #
   def self.path: (string | _ToPath path) -> String
 
@@ -1822,12 +1839,12 @@ class File < IO
   # Returns `false` if `File::LOCK_NB` is specified and the operation would have
   # blocked;
   # otherwise returns `0`.
-  #    Constant    |    Lock    |                                                    Effect
-  # ---------------|------------|--------------------------------------------------------------------------------------------------------------
-  # +File::LOCK_EX+| Exclusive  |                      Only one process may hold an exclusive lock for +self+ at a time.
-  # +File::LOCK_NB+|Non-blocking|No blocking; may be combined with +File::LOCK_SH+ or +File::LOCK_EX+ using the bitwise OR operator <tt>|</tt>.
-  # +File::LOCK_SH+|   Shared   |                 Multiple processes may each hold a shared lock for +self+ at the same time.
-  # +File::LOCK_UN+|   Unlock   |                                Remove an existing lock held by this process.
+  #    Constant    |    Lock    |                                                Effect
+  # ---------------|------------|-------------------------------------------------------------------------------------------------------
+  # `File::LOCK_EX`| Exclusive  |                   Only one process may hold an exclusive lock for `self` at a time.
+  # `File::LOCK_NB`|Non-blocking|No blocking; may be combined with `File::LOCK_SH` or `File::LOCK_EX` using the bitwise OR operator `|`.
+  # `File::LOCK_SH`|   Shared   |              Multiple processes may each hold a shared lock for `self` at the same time.
+  # `File::LOCK_UN`|   Unlock   |                             Remove an existing lock held by this process.
   # Example:
   #     # Update a counter using an exclusive lock.
   # # Don't use File::WRONLY because it truncates the file.
@@ -2429,10 +2446,8 @@ class File::Stat < Object
 
   # <!--
   #   rdoc-file=file.c
-  #   - new(p1)
+  #   - File::Stat.new(file_name)  -> stat
   # -->
-  # File::Stat.new(file_name)  -> stat
-  #
   # Create a File::Stat object for the given file name (raising an exception if
   # the file doesn't exist).
   #

data/core/file_test.rbs

@@ -145,7 +145,7 @@ module FileTest
   #   rdoc-file=file.c
   #   - File.owned?(file_name)   -> true or false
   # -->
-  # Returns `true` if the named file exists and the effective used id of the
+  # Returns `true` if the named file exists and the effective user id of the
   # calling process is the owner of the file.
   #
   # *file_name* can be an IO object.

data/core/float.rbs

@@ -1,15 +1,193 @@
-# <!-- rdoc-file=numeric.c -->
-# A Float object represents a sometimes-inexact real number using the native
-# architecture's double-precision floating point representation.
+# <!-- rdoc-file=float.rb -->
+# A Float object stores a real number using the native architecture's
+# double-precision floating-point representation.
+#
+# ## Float Imprecisions
+#
+# Some real numbers can be represented precisely as Float objects:
+#
+#     37.5    # => 37.5
+#     98.75   # => 98.75
+#     12.3125 # => 12.3125
+#
+# Others cannot; among these are the transcendental numbers, including:
+#
+# *   Pi, *π*: in mathematics, a number of infinite precision:
+#     3.1415926535897932384626433... (to 25 places); in Ruby, it is of limited
+#     precision (in this case, to 16 decimal places):
+#
+#         Math::PI # => 3.141592653589793
+#
+# *   Euler's number, *e*: in mathematics, a number of infinite precision:
+#     2.7182818284590452353602874... (to 25 places); in Ruby, it is of limited
+#     precision (in this case, to 15 decimal places):
+#
+#         Math::E # => 2.718281828459045
+#
+# Some floating-point computations in Ruby give precise results:
+#
+#     1.0/2   # => 0.5
+#     100.0/8 # => 12.5
+#
+# Others do not:
+#
+# *   In mathematics, 2/3 as a decimal number is an infinitely-repeating
+#     decimal: 0.666... (forever); in Ruby, `2.0/3` is of limited precision (in
+#     this case, to 16 decimal places):
+#
+#         2.0/3 # => 0.6666666666666666
+#
+# *   In mathematics, the square root of 2 is an irrational number of infinite
+#     precision: 1.4142135623730950488016887... (to 25 decimal places); in Ruby,
+#     it is of limited precision (in this case, to 16 decimal places):
+#
+#         Math.sqrt(2.0) # => 1.4142135623730951
+#
+# *   Even a simple computation can introduce imprecision:
+#
+#         x = 0.1 + 0.2 # => 0.30000000000000004
+#         y = 0.3       # => 0.3
+#         x == y        # => false
+#
+# See:
+#
+# *   https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
+# *   https://github.com/rdp/ruby_tutorials_core/wiki/Ruby-Talk-FAQ#-why-are-rub
+#     ys-floats-imprecise
+# *   https://en.wikipedia.org/wiki/Floating_point#Accuracy_problems
+#
+# Note that precise storage and computation of rational numbers is possible
+# using Rational objects.
+#
+# ## Creating a Float
+#
+# You can create a Float object explicitly with:
+#
+# *   A [floating-point literal](rdoc-ref:syntax/literals.rdoc@Float+Literals).
+#
+# You can convert certain objects to Floats with:
+#
+# *   Method #Float.
+#
+# ## What's Here
+#
+# First, what's elsewhere. Class Float:
+#
+# *   Inherits from [class Numeric](rdoc-ref:Numeric@What-27s+Here) and [class
+#     Object](rdoc-ref:Object@What-27s+Here).
+# *   Includes [module Comparable](rdoc-ref:Comparable@What-27s+Here).
+#
+# Here, class Float provides methods for:
+#
+# *   [Querying](rdoc-ref:Float@Querying)
+# *   [Comparing](rdoc-ref:Float@Comparing)
+# *   [Converting](rdoc-ref:Float@Converting)
+#
+# ### Querying
+#
+# *   #finite?: Returns whether `self` is finite.
+# *   #hash: Returns the integer hash code for `self`.
+# *   #infinite?: Returns whether `self` is infinite.
+# *   #nan?: Returns whether `self` is a NaN (not-a-number).
+#
+# ### Comparing
 #
-# Floating point has a different arithmetic and is an inexact number. So you
-# should know its esoteric system. See following:
+# *   #<: Returns whether `self` is less than the given value.
+# *   #<=: Returns whether `self` is less than or equal to the given value.
+# *   #<=>: Returns a number indicating whether `self` is less than, equal to,
+#     or greater than the given value.
+# *   #== (aliased as #=== and #eql?): Returns whether `self` is equal to the
+#     given value.
+# *   #>: Returns whether `self` is greater than the given value.
+# *   #>=: Returns whether `self` is greater than or equal to the given value.
+#
+# ### Converting
+#
+# *   #% (aliased as #modulo): Returns `self` modulo the given value.
+# *   #*: Returns the product of `self` and the given value.
+# *   #**: Returns the value of `self` raised to the power of the given value.
+# *   #+: Returns the sum of `self` and the given value.
+# *   #-: Returns the difference of `self` and the given value.
+# *   #/: Returns the quotient of `self` and the given value.
+# *   #ceil: Returns the smallest number greater than or equal to `self`.
+# *   #coerce: Returns a 2-element array containing the given value converted to
+#     a Float and `self`
+# *   #divmod: Returns a 2-element array containing the quotient and remainder
+#     results of dividing `self` by the given value.
+# *   #fdiv: Returns the Float result of dividing `self` by the given value.
+# *   #floor: Returns the greatest number smaller than or equal to `self`.
+# *   #next_float: Returns the next-larger representable Float.
+# *   #prev_float: Returns the next-smaller representable Float.
+# *   #quo: Returns the quotient from dividing `self` by the given value.
+# *   #round: Returns `self` rounded to the nearest value, to a given precision.
+# *   #to_i (aliased as #to_int): Returns `self` truncated to an Integer.
+# *   #to_s (aliased as #inspect): Returns a string containing the place-value
+#     representation of `self` in the given radix.
+# *   #truncate: Returns `self` truncated to a given precision.
+#
+# <!-- rdoc-file=float.rb -->
+# A Float object stores a real number using the native architecture's
+# double-precision floating-point representation.
+#
+# ## Float Imprecisions
+#
+# Some real numbers can be represented precisely as Float objects:
+#
+#     37.5    # => 37.5
+#     98.75   # => 98.75
+#     12.3125 # => 12.3125
+#
+# Others cannot; among these are the transcendental numbers, including:
+#
+# *   Pi, *π*: in mathematics, a number of infinite precision:
+#     3.1415926535897932384626433... (to 25 places); in Ruby, it is of limited
+#     precision (in this case, to 16 decimal places):
+#
+#         Math::PI # => 3.141592653589793
+#
+# *   Euler's number, *e*: in mathematics, a number of infinite precision:
+#     2.7182818284590452353602874... (to 25 places); in Ruby, it is of limited
+#     precision (in this case, to 15 decimal places):
+#
+#         Math::E # => 2.718281828459045
+#
+# Some floating-point computations in Ruby give precise results:
+#
+#     1.0/2   # => 0.5
+#     100.0/8 # => 12.5
+#
+# Others do not:
+#
+# *   In mathematics, 2/3 as a decimal number is an infinitely-repeating
+#     decimal: 0.666... (forever); in Ruby, `2.0/3` is of limited precision (in
+#     this case, to 16 decimal places):
+#
+#         2.0/3 # => 0.6666666666666666
+#
+# *   In mathematics, the square root of 2 is an irrational number of infinite
+#     precision: 1.4142135623730950488016887... (to 25 decimal places); in Ruby,
+#     it is of limited precision (in this case, to 16 decimal places):
+#
+#         Math.sqrt(2.0) # => 1.4142135623730951
+#
+# *   Even a simple computation can introduce imprecision:
+#
+#         x = 0.1 + 0.2 # => 0.30000000000000004
+#         y = 0.3       # => 0.3
+#         x == y        # => false
+#
+# See:
 #
 # *   https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html
 # *   https://github.com/rdp/ruby_tutorials_core/wiki/Ruby-Talk-FAQ#-why-are-rub
 #     ys-floats-imprecise
 # *   https://en.wikipedia.org/wiki/Floating_point#Accuracy_problems
 #
+# Note that precise storage and computation of rational numbers is possible
+# using Rational objects.
+#
+# ## Creating a Float
+#
 # You can create a Float object explicitly with:
 #
 # *   A [floating-point literal](rdoc-ref:syntax/literals.rdoc@Float+Literals).
@@ -79,7 +257,7 @@ class Float < Numeric
   #   rdoc-file=numeric.c
   #   - self % other -> float
   # -->
-  # Returns `self` modulo `other` as a float.
+  # Returns `self` modulo `other` as a Float.
   #
   # For float `f` and real number `r`, these expressions are equivalent:
   #
@@ -111,7 +289,7 @@ class Float < Numeric
   #   rdoc-file=numeric.c
   #   - self * other -> numeric
   # -->
-  # Returns a new Float which is the product of `self` and `other`:
+  # Returns the numeric product of `self` and `other`:
   #
   #     f = 3.14
   #     f * 2              # => 6.28
@@ -124,9 +302,9 @@ class Float < Numeric
 
   # <!--
   #   rdoc-file=numeric.c
-  #   - self ** other -> numeric
+  #   - self ** exponent -> numeric
   # -->
-  # Raises `self` to the power of `other`:
+  # Returns `self` raised to the power `exponent`:
   #
   #     f = 3.14
   #     f ** 2              # => 9.8596
@@ -140,15 +318,20 @@ class Float < Numeric
 
   # <!--
   #   rdoc-file=numeric.c
-  #   - self + other -> numeric
+  #   - self + other -> float or complex
   # -->
-  # Returns a new Float which is the sum of `self` and `other`:
+  # Returns the sum of `self` and `other`; the result may be inexact (see Float):
   #
-  #     f = 3.14
-  #     f + 1                 # => 4.140000000000001
-  #     f + 1.0               # => 4.140000000000001
-  #     f + Rational(1, 1)    # => 4.140000000000001
-  #     f + Complex(1, 0)     # => (4.140000000000001+0i)
+  #     3.14 + 0              # => 3.14
+  #     3.14 + 1              # => 4.140000000000001
+  #     -3.14 + 0             # => -3.14
+  #     -3.14 + 1             # => -2.14
+  #
+  #     3.14 + -3.14          # => 0.0
+  #     -3.14 + -3.14         # => -6.28
+  #
+  #     3.14 + Complex(1, 0)   # => (4.140000000000001+0i)
+  #     3.14 + Rational(1, 1)  # => 4.140000000000001
   #
   def +: (Complex) -> Complex
        | (Numeric) -> Float
@@ -159,7 +342,7 @@ class Float < Numeric
   #   rdoc-file=numeric.c
   #   - self - other -> numeric
   # -->
-  # Returns a new Float which is the difference of `self` and `other`:
+  # Returns the difference of `self` and `other`:
   #
   #     f = 3.14
   #     f - 1                 # => 2.14
@@ -172,9 +355,13 @@ class Float < Numeric
 
   # <!--
   #   rdoc-file=numeric.rb
-  #   - -float -> float
+  #   - -self -> float
   # -->
-  # Returns `self`, negated.
+  # Returns `self`, negated:
+  #
+  #     -3.14    # => -3.14
+  #     -(-3.14) # => 3.14
+  #     -0.0     # => -0.0
   #
   def -@: () -> Float
 
@@ -182,7 +369,7 @@ class Float < Numeric
   #   rdoc-file=numeric.c
   #   - self / other -> numeric
   # -->
-  # Returns a new Float which is the result of dividing `self` by `other`:
+  # Returns the quotient of `self` and `other`:
   #
   #     f = 3.14
   #     f / 2              # => 1.57
@@ -646,7 +833,7 @@ class Float < Numeric
   alias magnitude abs
 
   # <!-- rdoc-file=numeric.c -->
-  # Returns `self` modulo `other` as a float.
+  # Returns `self` modulo `other` as a Float.
   #
   # For float `f` and real number `r`, these expressions are equivalent:
   #
@@ -1094,7 +1281,7 @@ Float::MAX_EXP: Integer
 # Usually defaults to 2.2250738585072014e-308.
 #
 # If the platform supports denormalized numbers, there are numbers between zero
-# and Float::MIN. 0.0.next_float returns the smallest positive floating point
+# and Float::MIN. `0.0.next_float` returns the smallest positive floating point
 # number including denormalized numbers.
 #
 Float::MIN: Float