rbs 2.0.0 → 2.2.2

data/core/errno.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=error.c -->
 # Ruby exception objects are subclasses of Exception.  However, operating
 # systems typically report errors using plain integers. Module Errno is created
 # dynamically to map these operating system errors to Ruby classes, with each
@@ -19,16 +20,6 @@
 # available as the constants of Errno.
 #
 #     Errno.constants   #=> :E2BIG, :EACCES, :EADDRINUSE, :EADDRNOTAVAIL, ...
-# System call error module used by webrick for cross platform compatibility.
-#
-# EPROTO
-# :   protocol error
-# ECONNRESET
-# :   remote host reset the connection request
-# ECONNABORTED
-# :   Client sent TCP reset (RST) before server has accepted the connection
-#     requested by client.
-#
 #
 module Errno
 end

data/core/errors.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=error.c -->
 # Raised when the arguments are wrong and there isn't a more specific Exception
 # class.
 #
@@ -20,17 +21,20 @@
 class ArgumentError < StandardError
 end
 
+# <!-- rdoc-file=thread_sync.c -->
 # The exception class which will be raised when pushing into a closed Queue.
-# See Queue#close and SizedQueue#close.
+# See Thread::Queue#close and Thread::SizedQueue#close.
 #
 class ClosedQueueError < StopIteration
 end
 
+# <!-- rdoc-file=error.c -->
 # EncodingError is the base class for encoding errors.
 #
 class EncodingError < StandardError
 end
 
+# <!-- rdoc-file=io.c -->
 # Raised by some IO operations when reaching the end of file. Many IO methods
 # exist in two forms,
 #
@@ -47,6 +51,7 @@ end
 class EOFError < IOError
 end
 
+# <!-- rdoc-file=numeric.c -->
 # Raised when attempting to convert special float values (in particular
 # `Infinity` or `NaN`) to numerical classes which don't support them.
 #
@@ -55,6 +60,7 @@ end
 class FloatDomainError < RangeError
 end
 
+# <!-- rdoc-file=error.c -->
 # Raised when there is an attempt to modify a frozen object.
 #
 #     [1, 2, 3].freeze << 4
@@ -64,6 +70,10 @@ end
 #     FrozenError: can't modify frozen Array
 #
 class FrozenError[T] < RuntimeError
+  # <!--
+  #   rdoc-file=error.c
+  #   - FrozenError.new(msg=nil, receiver: nil)  -> frozen_error
+  # -->
   # Construct a new FrozenError exception. If given the *receiver* parameter may
   # subsequently be examined using the FrozenError#receiver method.
   #
@@ -72,11 +82,16 @@ class FrozenError[T] < RuntimeError
   #
   def initialize: (?string? msg, ?receiver: T?) -> void
 
+  # <!--
+  #   rdoc-file=error.c
+  #   - frozen_error.receiver  -> object
+  # -->
   # Return the receiver associated with this FrozenError exception.
   #
   def receiver: () -> T?
 end
 
+# <!-- rdoc-file=error.c -->
 # Raised when the given index is invalid.
 #
 #     a = [:foo, :bar]
@@ -87,6 +102,7 @@ end
 class IndexError < StandardError
 end
 
+# <!-- rdoc-file=error.c -->
 # Raised when the interrupt signal is received, typically because the user has
 # pressed Control-C (on most posix platforms). As such, it is a subclass of
 # `SignalException`.
@@ -110,6 +126,7 @@ class Interrupt < SignalException
   def initialize: (?string) -> void
 end
 
+# <!-- rdoc-file=io.c -->
 # Raised when an IO operation fails.
 #
 #     File.open("/etc/hosts") {|f| f << "example"}
@@ -127,6 +144,7 @@ end
 class IOError < StandardError
 end
 
+# <!-- rdoc-file=error.c -->
 # Raised when the specified key is not found. It is a subclass of IndexError.
 #
 #     h = {"foo" => :bar}
@@ -134,19 +152,32 @@ end
 #     h.fetch("baz") #=> KeyError: key not found: "baz"
 #
 class KeyError[K, R] < IndexError
+  # <!--
+  #   rdoc-file=error.c
+  #   - KeyError.new(message=nil, receiver: nil, key: nil) -> key_error
+  # -->
   # Construct a new `KeyError` exception with the given message, receiver and key.
   #
   def initialize: (?string msg, ?receiver: R?, ?key: K?) -> void
 
+  # <!--
+  #   rdoc-file=error.c
+  #   - key_error.key  -> object
+  # -->
   # Return the key caused this KeyError exception.
   #
   def key: () -> K?
 
+  # <!--
+  #   rdoc-file=error.c
+  #   - key_error.receiver  -> object
+  # -->
   # Return the receiver associated with this KeyError exception.
   #
   def receiver: () -> R?
 end
 
+# <!-- rdoc-file=error.c -->
 # Raised when a file required (a Ruby script, extension library, ...) fails to
 # load.
 #
@@ -157,12 +188,13 @@ end
 #     LoadError: no such file to load -- this/file/does/not/exist
 #
 class LoadError < ScriptError
+  # <!-- rdoc-file=error.c -->
   # the path failed to load
   #
-  #
   def path: () -> String?
 end
 
+# <!-- rdoc-file=proc.c -->
 # Raised when Ruby can't yield as requested.
 #
 # A typical scenario is attempting to yield when no block is given:
@@ -188,16 +220,25 @@ end
 #     LocalJumpError: unexpected return
 #
 class LocalJumpError < StandardError
+  # <!--
+  #   rdoc-file=proc.c
+  #   - local_jump_error.exit_value  -> obj
+  # -->
   # Returns the exit value associated with this `LocalJumpError`.
   #
   def exit_value: () -> untyped
 
+  # <!--
+  #   rdoc-file=proc.c
+  #   - local_jump_error.reason   -> symbol
+  # -->
   # The reason this block was terminated: :break, :redo, :retry, :next, :return,
   # or :noreason.
   #
   def reason: () -> Symbol
 end
 
+# <!-- rdoc-file=error.c -->
 # Raised when a given name is invalid or undefined.
 #
 #     puts foo
@@ -215,6 +256,10 @@ end
 #     NameError: wrong constant name answer
 #
 class NameError[T] < StandardError
+  # <!--
+  #   rdoc-file=error.c
+  #   - NameError.new(msg=nil, name=nil, receiver: nil)  -> name_error
+  # -->
   # Construct a new NameError exception. If given the *name* parameter may
   # subsequently be examined using the NameError#name method. *receiver* parameter
   # allows to pass object in context of which the error happened. Example:
@@ -226,6 +271,10 @@ class NameError[T] < StandardError
 
   public
 
+  # <!--
+  #   rdoc-file=error.c
+  #   - name_error.local_variables  ->  array
+  # -->
   # Return a list of the local variable names defined where this NameError
   # exception was raised.
   #
@@ -233,20 +282,30 @@ class NameError[T] < StandardError
   #
   def local_variables: () -> ::Array[Symbol]
 
+  # <!--
+  #   rdoc-file=error.c
+  #   - name_error.name    ->  string or nil
+  # -->
   # Return the name associated with this NameError exception.
   #
   def name: () -> String?
 
+  # <!--
+  #   rdoc-file=error.c
+  #   - name_error.receiver  -> object
+  # -->
   # Return the receiver associated with this NameError exception.
   #
   def receiver: () -> T?
 end
 
+# <!-- rdoc-file=error.c -->
 # Raised when memory allocation fails.
 #
 class NoMemoryError < Exception
 end
 
+# <!-- rdoc-file=error.c -->
 # Raised when a method is called on a receiver which doesn't have it defined and
 # also fails to respond with `method_missing`.
 #
@@ -257,6 +316,10 @@ end
 #     NoMethodError: undefined method `to_ary' for "hello":String
 #
 class NoMethodError[T] < NameError[T]
+  # <!--
+  #   rdoc-file=error.c
+  #   - NoMethodError.new(msg=nil, name=nil, args=nil, private=false, receiver: nil)  -> no_method_error
+  # -->
   # Construct a NoMethodError exception for a method of the given name called with
   # the given arguments. The name may be accessed using the `#name` method on the
   # resulting object, and the arguments using the `#args` method.
@@ -270,15 +333,24 @@ class NoMethodError[T] < NameError[T]
 
   public
 
+  # <!--
+  #   rdoc-file=error.c
+  #   - no_method_error.args  -> obj
+  # -->
   # Return the arguments passed in as the third parameter to the constructor.
   #
   def args: () -> Array[untyped]
 
+  # <!--
+  #   rdoc-file=error.c
+  #   - no_method_error.private_call?  -> true or false
+  # -->
   # Return true if the caused method was called as private.
   #
   def private_call?: () -> bool
 end
 
+# <!-- rdoc-file=error.c -->
 # Raised when a feature is not implemented on the current platform. For example,
 # methods depending on the `fsync` or `fork` system calls may raise this
 # exception if the underlying operating system or Ruby runtime does not support
@@ -290,6 +362,7 @@ end
 class NotImplementedError < ScriptError
 end
 
+# <!-- rdoc-file=error.c -->
 # Raised when a given numerical value is out of range.
 #
 #     [1, 2, 3].drop(1 << 100)
@@ -301,6 +374,7 @@ end
 class RangeError < StandardError
 end
 
+# <!-- rdoc-file=re.c -->
 # Raised when given an invalid regexp expression.
 #
 #     Regexp.new("?")
@@ -312,6 +386,7 @@ end
 class RegexpError < StandardError
 end
 
+# <!-- rdoc-file=error.c -->
 # A generic error class raised when an invalid operation is attempted.
 # Kernel#raise will raise a RuntimeError if no Exception class is specified.
 #
@@ -324,6 +399,7 @@ end
 class RuntimeError < StandardError
 end
 
+# <!-- rdoc-file=error.c -->
 # ScriptError is the superclass for errors raised when a script can not be
 # executed because of a `LoadError`, `NotImplementedError` or a `SyntaxError`.
 # Note these type of `ScriptErrors` are not `StandardError` and will not be
@@ -332,11 +408,13 @@ end
 class ScriptError < Exception
 end
 
+# <!-- rdoc-file=error.c -->
 # No longer used by internal code.
 #
 class SecurityError < Exception
 end
 
+# <!-- rdoc-file=error.c -->
 # Raised when a signal is received.
 #
 #     begin
@@ -351,6 +429,11 @@ end
 #     received Exception SIGHUP
 #
 class SignalException < Exception
+  # <!--
+  #   rdoc-file=signal.c
+  #   - SignalException.new(sig_name)              ->  signal_exception
+  #   - SignalException.new(sig_number [, name])   ->  signal_exception
+  # -->
   # Construct a new SignalException object.  `sig_name` should be a known signal
   # name.
   #
@@ -361,11 +444,16 @@ class SignalException < Exception
 
   def signm: () -> String
 
+  # <!--
+  #   rdoc-file=signal.c
+  #   - signal_exception.signo   ->  num
+  # -->
   # Returns a signal number.
   #
   def signo: () -> Integer
 end
 
+# <!-- rdoc-file=error.c -->
 # The most standard error types are subclasses of StandardError. A rescue clause
 # without an explicit Exception class will rescue all StandardErrors (and only
 # those).
@@ -386,6 +474,7 @@ end
 class StandardError < Exception
 end
 
+# <!-- rdoc-file=enumerator.c -->
 # Raised to stop the iteration, in particular by Enumerator#next. It is rescued
 # by Kernel#loop.
 #
@@ -402,6 +491,10 @@ end
 #     Done!
 #
 class StopIteration < IndexError
+  # <!--
+  #   rdoc-file=enumerator.c
+  #   - result       -> value
+  # -->
   # Returns the return value of the iterator.
   #
   #     o = Object.new
@@ -427,6 +520,7 @@ class StopIteration < IndexError
   def result: () -> untyped
 end
 
+# <!-- rdoc-file=error.c -->
 # Raised when encountering Ruby code with an invalid syntax.
 #
 #     eval("1+1=2")
@@ -436,11 +530,16 @@ end
 #     SyntaxError: (eval):1: syntax error, unexpected '=', expecting $end
 #
 class SyntaxError < ScriptError
+  # <!--
+  #   rdoc-file=error.c
+  #   - SyntaxError.new([msg])  -> syntax_error
+  # -->
   # Construct a SyntaxError exception.
   #
   def initialize: (?string msg) -> void
 end
 
+# <!-- rdoc-file=error.c -->
 # SystemCallError is the base class for all low-level platform-dependent errors.
 #
 # The errors available on the current platform are subclasses of SystemCallError
@@ -453,6 +552,10 @@ end
 #     Errno::ENOENT: No such file or directory - does/not/exist
 #
 class SystemCallError < StandardError
+  # <!--
+  #   rdoc-file=error.c
+  #   - SystemCallError.new(msg, errno)  -> 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
@@ -460,6 +563,10 @@ class SystemCallError < StandardError
   #
   def initialize: (string msg, Integer errno) -> SystemCallError
 
+  # <!--
+  #   rdoc-file=error.c
+  #   - system_call_error === other  -> true or false
+  # -->
   # Return `true` if the receiver is a generic `SystemCallError`, or if the error
   # numbers `self` and *other* are the same.
   #
@@ -467,14 +574,26 @@ class SystemCallError < StandardError
 
   public
 
+  # <!--
+  #   rdoc-file=error.c
+  #   - system_call_error.errno   -> integer
+  # -->
   # Return this SystemCallError's error number.
   #
   def errno: () -> Integer
 end
 
+# <!-- rdoc-file=error.c -->
 # Raised by `exit` to initiate the termination of the script.
 #
 class SystemExit < Exception
+  # <!--
+  #   rdoc-file=error.c
+  #   - SystemExit.new              -> system_exit
+  #   - SystemExit.new(status)      -> system_exit
+  #   - SystemExit.new(status, msg) -> system_exit
+  #   - SystemExit.new(msg)         -> system_exit
+  # -->
   # Create a new `SystemExit` exception with the given status and message. Status
   # is true, false, or an integer. If status is not given, true is used.
   #
@@ -484,15 +603,24 @@ class SystemExit < Exception
 
   public
 
+  # <!--
+  #   rdoc-file=error.c
+  #   - system_exit.status   -> integer
+  # -->
   # Return the status value associated with this system exit.
   #
   def status: () -> Integer
 
+  # <!--
+  #   rdoc-file=error.c
+  #   - system_exit.success?  -> true or false
+  # -->
   # Returns `true` if exiting successful, `false` if not.
   #
   def success?: () -> bool
 end
 
+# <!-- rdoc-file=proc.c -->
 # Raised in case of a stack overflow.
 #
 #     def me_myself_and_i
@@ -507,6 +635,7 @@ end
 class SystemStackError < Exception
 end
 
+# <!-- rdoc-file=thread.c -->
 # Raised when an invalid operation is attempted on a thread.
 #
 # For example, when no other thread has been started:
@@ -521,6 +650,7 @@ end
 class ThreadError < StandardError
 end
 
+# <!-- rdoc-file=error.c -->
 # Raised when encountering an object that is not of the expected type.
 #
 #     [1, 2, 3].first("two")
@@ -532,6 +662,7 @@ end
 class TypeError < StandardError
 end
 
+# <!-- rdoc-file=vm_eval.c -->
 # Raised when `throw` is called with a *tag* which does not have corresponding
 # `catch` block.
 #
@@ -542,6 +673,12 @@ end
 #     UncaughtThrowError: uncaught throw "foo"
 #
 class UncaughtThrowError < ArgumentError
+  # <!--
+  #   rdoc-file=vm_eval.c
+  #   - new(*args)
+  # -->
+  # Document-class: UncaughtThrowError
+  #
   # Raised when `throw` is called with a *tag* which does not have corresponding
   # `catch` block.
   #
@@ -555,19 +692,32 @@ class UncaughtThrowError < ArgumentError
 
   public
 
+  # <!--
+  #   rdoc-file=vm_eval.c
+  #   - uncaught_throw.tag   -> obj
+  # -->
   # Return the tag object which was called for.
   #
   def tag: () -> untyped
 
+  # <!--
+  #   rdoc-file=vm_eval.c
+  #   - uncaught_throw.to_s   ->  string
+  # -->
   # Returns formatted message with the inspected tag.
   #
   def to_s: () -> String
 
+  # <!--
+  #   rdoc-file=vm_eval.c
+  #   - uncaught_throw.value   -> obj
+  # -->
   # Return the return value which was called for.
   #
   def value: () -> untyped
 end
 
+# <!-- rdoc-file=numeric.c -->
 # Raised when attempting to divide an integer by 0.
 #
 #     42 / 0   #=> ZeroDivisionError: divided by 0