rbs 3.6.1 → 3.9.5

data/stdlib/uri/0/common.rbs

@@ -24,7 +24,7 @@ end
 
 # <!-- rdoc-file=lib/uri.rb -->
 # URI is a module providing classes to handle Uniform Resource Identifiers
-# ([RFC2396](http://tools.ietf.org/html/rfc2396)).
+# ([RFC2396](https://www.rfc-editor.org/rfc/rfc2396)).
 #
 # ## Features
 #
@@ -33,7 +33,6 @@ end
 # *   Flexibility to have an alternate URI::Parser (or just different patterns
 #     and regexp's).
 #
-#
 # ## Basic example
 #
 #     require 'uri'
@@ -72,15 +71,14 @@ end
 # A good place to view an RFC spec is http://www.ietf.org/rfc.html.
 #
 # Here is a list of all related RFC's:
-# *   [RFC822](http://tools.ietf.org/html/rfc822)
-# *   [RFC1738](http://tools.ietf.org/html/rfc1738)
-# *   [RFC2255](http://tools.ietf.org/html/rfc2255)
-# *   [RFC2368](http://tools.ietf.org/html/rfc2368)
-# *   [RFC2373](http://tools.ietf.org/html/rfc2373)
-# *   [RFC2396](http://tools.ietf.org/html/rfc2396)
-# *   [RFC2732](http://tools.ietf.org/html/rfc2732)
-# *   [RFC3986](http://tools.ietf.org/html/rfc3986)
-#
+# *   [RFC822](https://www.rfc-editor.org/rfc/rfc822)
+# *   [RFC1738](https://www.rfc-editor.org/rfc/rfc1738)
+# *   [RFC2255](https://www.rfc-editor.org/rfc/rfc2255)
+# *   [RFC2368](https://www.rfc-editor.org/rfc/rfc2368)
+# *   [RFC2373](https://www.rfc-editor.org/rfc/rfc2373)
+# *   [RFC2396](https://www.rfc-editor.org/rfc/rfc2396)
+# *   [RFC2732](https://www.rfc-editor.org/rfc/rfc2732)
+# *   [RFC3986](https://www.rfc-editor.org/rfc/rfc3986)
 #
 # ## Class tree
 #
@@ -89,31 +87,27 @@ end
 #     *   URI::FTP - (in uri/ftp.rb)
 #     *   URI::HTTP - (in uri/http.rb)
 #         *   URI::HTTPS - (in uri/https.rb)
-#
 #     *   URI::LDAP - (in uri/ldap.rb)
 #         *   URI::LDAPS - (in uri/ldaps.rb)
-#
 #     *   URI::MailTo - (in uri/mailto.rb)
-#
 # *   URI::Parser - (in uri/common.rb)
 # *   URI::REGEXP - (in uri/common.rb)
 #     *   URI::REGEXP::PATTERN - (in uri/common.rb)
-#
 # *   URI::Util - (in uri/common.rb)
 # *   URI::Error - (in uri/common.rb)
 #     *   URI::InvalidURIError - (in uri/common.rb)
 #     *   URI::InvalidComponentError - (in uri/common.rb)
 #     *   URI::BadURIError - (in uri/common.rb)
 #
-#
-#
 # ## Copyright Info
 #
 # Author
 # :   Akira Yamada <akira@ruby-lang.org>
+#
 # Documentation
 # :   Akira Yamada <akira@ruby-lang.org> Dmitry V. Sabanin <sdmitry@lrn.ru>
 #     Vincent Batts <vbatts@hashbangbash.com>
+#
 # License
 # :   Copyright (c) 2001 akira yamada <akira@ruby-lang.org> You can redistribute
 #     it and/or modify it under the same term as Ruby.
@@ -121,6 +115,14 @@ end
 module URI
   include URI::RFC2396_REGEXP
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - decode_uri_component(str, enc=Encoding::UTF_8)
+  # -->
+  # Like URI.decode_www_form_component, except that `'+'` is preserved.
+  #
+  def self.decode_uri_component: (String str, ?encoding enc) -> String
+
   # <!--
   #   rdoc-file=lib/uri/common.rb
   #   - decode_www_form(str, enc=Encoding::UTF_8, separator: '&', use__charset_: false, isindex: false)
@@ -176,7 +178,6 @@ module URI
   #     *   Characters `'*'`, `'.'`, `'-'`, and `'_'`.
   #     *   Character in ranges `'a'..'z'`, `'A'..'Z'`, and `'0'..'9'`.
   #
-  #
   #     Example:
   #
   #         URI.decode_www_form_component('*.-_azAZ09')
@@ -187,17 +188,24 @@ module URI
   #     *   Character `'+'` to character `' '`.
   #     *   Each "percent notation" to an ASCII character.
   #
-  #
   #     Example:
   #
   #         URI.decode_www_form_component('Here+are+some+punctuation+characters%3A+%2C%3B%3F%3A')
   #         # => "Here are some punctuation characters: ,;?:"
   #
-  #
   # Related: URI.decode_uri_component (preserves `'+'`).
   #
   def self.decode_www_form_component: (String str, ?encoding enc) -> String
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - encode_uri_component(str, enc=nil)
+  # -->
+  # Like URI.encode_www_form_component, except that `' '` (space) is encoded as
+  # `'%20'` (instead of `'+'`).
+  #
+  def self.encode_uri_component: (String str, ?encoding enc) -> String
+
   # <!--
   #   rdoc-file=lib/uri/common.rb
   #   - encode_www_form(enum, enc=nil)
@@ -258,7 +266,6 @@ module URI
   #         URI.encode_www_form(['foo', :bar, 0])
   #         # => "foo&bar&0"
   #
-  #
   # The elements of an Array-like `enum` may be mixture:
   #
   #     URI.encode_www_form([['foo', 0], ['bar', 1, 2], ['baz'], :bat])
@@ -292,7 +299,6 @@ module URI
   #         URI.encode_www_form({foo: 0, bar: 1, baz: 2})
   #         # => "foo=0&bar=1&baz=2"
   #
-  #
   # The elements of a Hash-like `enum` may be mixture:
   #
   #     URI.encode_www_form({foo: [0, 1], bar: 2})
@@ -313,7 +319,6 @@ module URI
   #     *   Characters `'*'`, `'.'`, `'-'`, and `'_'`.
   #     *   Character in ranges `'a'..'z'`, `'A'..'Z'`, and `'0'..'9'`.
   #
-  #
   #     Example:
   #
   #         URI.encode_www_form_component('*.-_azAZ09')
@@ -325,20 +330,17 @@ module URI
   #     *   Any other character to "percent notation"; the percent notation for
   #         character *c* is `'%%%X' % c.ord`.
   #
-  #
   #     Example:
   #
   #         URI.encode_www_form_component('Here are some punctuation characters: ,;?:')
   #         # => "Here+are+some+punctuation+characters%3A+%2C%3B%3F%3A"
   #
-  #
   # Encoding:
   #
   # *   If `str` has encoding Encoding::ASCII_8BIT, argument `enc` is ignored.
   # *   Otherwise `str` is converted first to Encoding::UTF_8 (with suitable
   #     character replacements), and then to encoding `enc`.
   #
-  #
   # In either case, the returned string has forced encoding Encoding::US_ASCII.
   #
   # Related: URI.encode_uri_component (encodes `' '` as `'%20'`).
@@ -493,7 +495,6 @@ module URI
   # *   The object is initialized by calling the class initializer using `scheme`
   #     and `arguments`. See URI::Generic.new.
   #
-  #
   # Examples:
   #
   #     values = ['john.doe', 'www.example.com', '123', nil, '/forum/questions/', nil, 'tag=networking&order=newest', 'top']
@@ -534,9 +535,6 @@ URI::ABS_URI: Regexp
 
 URI::ABS_URI_REF: Regexp
 
-# <!-- rdoc-file=lib/uri/common.rb -->
-# URI::Parser.new
-#
 URI::DEFAULT_PARSER: URI::RFC2396_Parser
 
 URI::ESCAPED: Regexp

data/stdlib/uri/0/ftp.rbs

@@ -6,7 +6,7 @@ module URI
   # This class will be redesigned because of difference of implementations; the
   # structure of its path. draft-hoffman-ftp-uri-04 is a draft but it is a good
   # summary about the de facto spec.
-  # http://tools.ietf.org/html/draft-hoffman-ftp-uri-04
+  # https://datatracker.ietf.org/doc/html/draft-hoffman-ftp-uri-04
   #
   class FTP < Generic
   end

data/stdlib/uri/0/generic.rbs

@@ -1,6 +1,6 @@
 # <!-- rdoc-file=lib/uri.rb -->
 # URI is a module providing classes to handle Uniform Resource Identifiers
-# ([RFC2396](http://tools.ietf.org/html/rfc2396)).
+# ([RFC2396](https://www.rfc-editor.org/rfc/rfc2396)).
 #
 # ## Features
 #
@@ -9,7 +9,6 @@
 # *   Flexibility to have an alternate URI::Parser (or just different patterns
 #     and regexp's).
 #
-#
 # ## Basic example
 #
 #     require 'uri'
@@ -48,15 +47,14 @@
 # A good place to view an RFC spec is http://www.ietf.org/rfc.html.
 #
 # Here is a list of all related RFC's:
-# *   [RFC822](http://tools.ietf.org/html/rfc822)
-# *   [RFC1738](http://tools.ietf.org/html/rfc1738)
-# *   [RFC2255](http://tools.ietf.org/html/rfc2255)
-# *   [RFC2368](http://tools.ietf.org/html/rfc2368)
-# *   [RFC2373](http://tools.ietf.org/html/rfc2373)
-# *   [RFC2396](http://tools.ietf.org/html/rfc2396)
-# *   [RFC2732](http://tools.ietf.org/html/rfc2732)
-# *   [RFC3986](http://tools.ietf.org/html/rfc3986)
-#
+# *   [RFC822](https://www.rfc-editor.org/rfc/rfc822)
+# *   [RFC1738](https://www.rfc-editor.org/rfc/rfc1738)
+# *   [RFC2255](https://www.rfc-editor.org/rfc/rfc2255)
+# *   [RFC2368](https://www.rfc-editor.org/rfc/rfc2368)
+# *   [RFC2373](https://www.rfc-editor.org/rfc/rfc2373)
+# *   [RFC2396](https://www.rfc-editor.org/rfc/rfc2396)
+# *   [RFC2732](https://www.rfc-editor.org/rfc/rfc2732)
+# *   [RFC3986](https://www.rfc-editor.org/rfc/rfc3986)
 #
 # ## Class tree
 #
@@ -65,31 +63,27 @@
 #     *   URI::FTP - (in uri/ftp.rb)
 #     *   URI::HTTP - (in uri/http.rb)
 #         *   URI::HTTPS - (in uri/https.rb)
-#
 #     *   URI::LDAP - (in uri/ldap.rb)
 #         *   URI::LDAPS - (in uri/ldaps.rb)
-#
 #     *   URI::MailTo - (in uri/mailto.rb)
-#
 # *   URI::Parser - (in uri/common.rb)
 # *   URI::REGEXP - (in uri/common.rb)
 #     *   URI::REGEXP::PATTERN - (in uri/common.rb)
-#
 # *   URI::Util - (in uri/common.rb)
 # *   URI::Error - (in uri/common.rb)
 #     *   URI::InvalidURIError - (in uri/common.rb)
 #     *   URI::InvalidComponentError - (in uri/common.rb)
 #     *   URI::BadURIError - (in uri/common.rb)
 #
-#
-#
 # ## Copyright Info
 #
 # Author
 # :   Akira Yamada <akira@ruby-lang.org>
+#
 # Documentation
 # :   Akira Yamada <akira@ruby-lang.org> Dmitry V. Sabanin <sdmitry@lrn.ru>
 #     Vincent Batts <vbatts@hashbangbash.com>
+#
 # License
 # :   Copyright (c) 2001 akira yamada <akira@ruby-lang.org> You can redistribute
 #     it and/or modify it under the same term as Ruby.
@@ -182,24 +176,34 @@ module URI
     #
     # `scheme`
     # :   Protocol scheme, i.e. 'http','ftp','mailto' and so on.
+    #
     # `userinfo`
     # :   User name and password, i.e. 'sdmitry:bla'.
+    #
     # `host`
     # :   Server host name.
+    #
     # `port`
     # :   Server port.
+    #
     # `registry`
     # :   Registry of naming authorities.
+    #
     # `path`
     # :   Path on server.
+    #
     # `opaque`
     # :   Opaque part.
+    #
     # `query`
     # :   Query data.
+    #
     # `fragment`
     # :   Part of the URI after '#' character.
+    #
     # `parser`
     # :   Parser for internal use [URI::DEFAULT_PARSER by default].
+    #
     # `arg_check`
     # :   Check arguments [false by default].
     #
@@ -809,7 +813,7 @@ module URI
     # ## Description
     #
     # URI has components listed in order of decreasing significance from left to
-    # right, see RFC3986 https://tools.ietf.org/html/rfc3986 1.2.3.
+    # right, see RFC3986 https://www.rfc-editor.org/rfc/rfc3986 1.2.3.
     #
     # ## Usage
     #

data/stdlib/uri/0/http.rbs

@@ -55,7 +55,7 @@ module URI
     # ## Description
     #
     # Returns the authority for an HTTP uri, as defined in
-    # https://datatracker.ietf.org/doc/html/rfc3986/#section-3.2.
+    # https://www.rfc-editor.org/rfc/rfc3986#section-3.2.
     #
     # Example:
     #
@@ -72,7 +72,7 @@ module URI
     # ## Description
     #
     # Returns the origin for an HTTP uri, as defined in
-    # https://datatracker.ietf.org/doc/html/rfc6454.
+    # https://www.rfc-editor.org/rfc/rfc6454.
     #
     # Example:
     #

data/stdlib/uri/0/rfc2396_parser.rbs

@@ -73,6 +73,7 @@ module URI
     #
     # `str`
     # :   String to make safe
+    #
     # `unsafe`
     # :   Regexp to apply. Defaults to `self.regexp[:UNSAFE]`
     #
@@ -94,6 +95,7 @@ module URI
     #
     # `str`
     # :   String to search
+    #
     # `schemes`
     # :   Patterns to apply to `str`
     #
@@ -173,6 +175,7 @@ module URI
     #
     # `str`
     # :   String to remove escapes from
+    #
     # `escaped`
     # :   Regexp to apply. Defaults to `self.regexp[:ESCAPED]`
     #

data/stdlib/zlib/0/buf_error.rbs

@@ -1,73 +1,4 @@
-# <!-- rdoc-file=ext/zlib/zlib.c -->
-# This module provides access to the [zlib library](http://zlib.net). Zlib is
-# designed to be a portable, free, general-purpose, legally unencumbered -- that
-# is, not covered by any patents -- lossless data-compression library for use on
-# virtually any computer hardware and operating system.
-#
-# The zlib compression library provides in-memory compression and decompression
-# functions, including integrity checks of the uncompressed data.
-#
-# The zlib compressed data format is described in RFC 1950, which is a wrapper
-# around a deflate stream which is described in RFC 1951.
-#
-# The library also supports reading and writing files in gzip (.gz) format with
-# an interface similar to that of IO. The gzip format is described in RFC 1952
-# which is also a wrapper around a deflate stream.
-#
-# The zlib format was designed to be compact and fast for use in memory and on
-# communications channels. The gzip format was designed for single-file
-# compression on file systems, has a larger header than zlib to maintain
-# directory information, and uses a different, slower check method than zlib.
-#
-# See your system's zlib.h for further information about zlib
-#
-# ## Sample usage
-#
-# Using the wrapper to compress strings with default parameters is quite simple:
-#
-#     require "zlib"
-#
-#     data_to_compress = File.read("don_quixote.txt")
-#
-#     puts "Input size: #{data_to_compress.size}"
-#     #=> Input size: 2347740
-#
-#     data_compressed = Zlib::Deflate.deflate(data_to_compress)
-#
-#     puts "Compressed size: #{data_compressed.size}"
-#     #=> Compressed size: 887238
-#
-#     uncompressed_data = Zlib::Inflate.inflate(data_compressed)
-#
-#     puts "Uncompressed data is: #{uncompressed_data}"
-#     #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
-#
-# ## Class tree
-#
-# *   Zlib::Deflate
-# *   Zlib::Inflate
-# *   Zlib::ZStream
-# *   Zlib::Error
-#     *   Zlib::StreamEnd
-#     *   Zlib::NeedDict
-#     *   Zlib::DataError
-#     *   Zlib::StreamError
-#     *   Zlib::MemError
-#     *   Zlib::BufError
-#     *   Zlib::VersionError
-#     *   Zlib::InProgressError
-#
-#
-#
-# (if you have GZIP_SUPPORT)
-# *   Zlib::GzipReader
-# *   Zlib::GzipWriter
-# *   Zlib::GzipFile
-# *   Zlib::GzipFile::Error
-#     *   Zlib::GzipFile::LengthError
-#     *   Zlib::GzipFile::CRCError
-#     *   Zlib::GzipFile::NoFooter
-#
+%a{annotate:rdoc:skip}
 module Zlib
   # <!-- rdoc-file=ext/zlib/zlib.c -->
   # Subclass of Zlib::Error when zlib returns a Z_BUF_ERROR.

data/stdlib/zlib/0/data_error.rbs

@@ -1,73 +1,4 @@
-# <!-- rdoc-file=ext/zlib/zlib.c -->
-# This module provides access to the [zlib library](http://zlib.net). Zlib is
-# designed to be a portable, free, general-purpose, legally unencumbered -- that
-# is, not covered by any patents -- lossless data-compression library for use on
-# virtually any computer hardware and operating system.
-#
-# The zlib compression library provides in-memory compression and decompression
-# functions, including integrity checks of the uncompressed data.
-#
-# The zlib compressed data format is described in RFC 1950, which is a wrapper
-# around a deflate stream which is described in RFC 1951.
-#
-# The library also supports reading and writing files in gzip (.gz) format with
-# an interface similar to that of IO. The gzip format is described in RFC 1952
-# which is also a wrapper around a deflate stream.
-#
-# The zlib format was designed to be compact and fast for use in memory and on
-# communications channels. The gzip format was designed for single-file
-# compression on file systems, has a larger header than zlib to maintain
-# directory information, and uses a different, slower check method than zlib.
-#
-# See your system's zlib.h for further information about zlib
-#
-# ## Sample usage
-#
-# Using the wrapper to compress strings with default parameters is quite simple:
-#
-#     require "zlib"
-#
-#     data_to_compress = File.read("don_quixote.txt")
-#
-#     puts "Input size: #{data_to_compress.size}"
-#     #=> Input size: 2347740
-#
-#     data_compressed = Zlib::Deflate.deflate(data_to_compress)
-#
-#     puts "Compressed size: #{data_compressed.size}"
-#     #=> Compressed size: 887238
-#
-#     uncompressed_data = Zlib::Inflate.inflate(data_compressed)
-#
-#     puts "Uncompressed data is: #{uncompressed_data}"
-#     #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
-#
-# ## Class tree
-#
-# *   Zlib::Deflate
-# *   Zlib::Inflate
-# *   Zlib::ZStream
-# *   Zlib::Error
-#     *   Zlib::StreamEnd
-#     *   Zlib::NeedDict
-#     *   Zlib::DataError
-#     *   Zlib::StreamError
-#     *   Zlib::MemError
-#     *   Zlib::BufError
-#     *   Zlib::VersionError
-#     *   Zlib::InProgressError
-#
-#
-#
-# (if you have GZIP_SUPPORT)
-# *   Zlib::GzipReader
-# *   Zlib::GzipWriter
-# *   Zlib::GzipFile
-# *   Zlib::GzipFile::Error
-#     *   Zlib::GzipFile::LengthError
-#     *   Zlib::GzipFile::CRCError
-#     *   Zlib::GzipFile::NoFooter
-#
+%a{annotate:rdoc:skip}
 module Zlib
   # <!-- rdoc-file=ext/zlib/zlib.c -->
   # Subclass of Zlib::Error when zlib returns a Z_DATA_ERROR.

data/stdlib/zlib/0/deflate.rbs

@@ -1,73 +1,4 @@
-# <!-- rdoc-file=ext/zlib/zlib.c -->
-# This module provides access to the [zlib library](http://zlib.net). Zlib is
-# designed to be a portable, free, general-purpose, legally unencumbered -- that
-# is, not covered by any patents -- lossless data-compression library for use on
-# virtually any computer hardware and operating system.
-#
-# The zlib compression library provides in-memory compression and decompression
-# functions, including integrity checks of the uncompressed data.
-#
-# The zlib compressed data format is described in RFC 1950, which is a wrapper
-# around a deflate stream which is described in RFC 1951.
-#
-# The library also supports reading and writing files in gzip (.gz) format with
-# an interface similar to that of IO. The gzip format is described in RFC 1952
-# which is also a wrapper around a deflate stream.
-#
-# The zlib format was designed to be compact and fast for use in memory and on
-# communications channels. The gzip format was designed for single-file
-# compression on file systems, has a larger header than zlib to maintain
-# directory information, and uses a different, slower check method than zlib.
-#
-# See your system's zlib.h for further information about zlib
-#
-# ## Sample usage
-#
-# Using the wrapper to compress strings with default parameters is quite simple:
-#
-#     require "zlib"
-#
-#     data_to_compress = File.read("don_quixote.txt")
-#
-#     puts "Input size: #{data_to_compress.size}"
-#     #=> Input size: 2347740
-#
-#     data_compressed = Zlib::Deflate.deflate(data_to_compress)
-#
-#     puts "Compressed size: #{data_compressed.size}"
-#     #=> Compressed size: 887238
-#
-#     uncompressed_data = Zlib::Inflate.inflate(data_compressed)
-#
-#     puts "Uncompressed data is: #{uncompressed_data}"
-#     #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
-#
-# ## Class tree
-#
-# *   Zlib::Deflate
-# *   Zlib::Inflate
-# *   Zlib::ZStream
-# *   Zlib::Error
-#     *   Zlib::StreamEnd
-#     *   Zlib::NeedDict
-#     *   Zlib::DataError
-#     *   Zlib::StreamError
-#     *   Zlib::MemError
-#     *   Zlib::BufError
-#     *   Zlib::VersionError
-#     *   Zlib::InProgressError
-#
-#
-#
-# (if you have GZIP_SUPPORT)
-# *   Zlib::GzipReader
-# *   Zlib::GzipWriter
-# *   Zlib::GzipFile
-# *   Zlib::GzipFile::Error
-#     *   Zlib::GzipFile::LengthError
-#     *   Zlib::GzipFile::CRCError
-#     *   Zlib::GzipFile::NoFooter
-#
+%a{annotate:rdoc:skip}
 module Zlib
   # <!-- rdoc-file=ext/zlib/zlib.c -->
   # Zlib::Deflate is the class for compressing data.  See Zlib::ZStream for more
@@ -126,10 +57,13 @@ module Zlib
     #
     # Zlib::NO_FLUSH
     # :   The default
+    #
     # Zlib::SYNC_FLUSH
     # :   Flushes the output to a byte boundary
+    #
     # Zlib::FULL_FLUSH
     # :   SYNC_FLUSH + resets the compression state
+    #
     # Zlib::FINISH
     # :   Pending input is processed, pending output is flushed.
     #
@@ -198,7 +132,6 @@ module Zlib
     # *   Zlib::BEST_SPEED
     # *   Zlib::BEST_COMPRESSION
     #
-    #
     # See http://www.zlib.net/manual.html#Constants for further information.
     #
     # The `window_bits` sets the size of the history buffer and should be between 8
@@ -213,18 +146,21 @@ module Zlib
     # *   Zlib::DEF_MEM_LEVEL
     # *   Zlib::MAX_MEM_LEVEL
     #
-    #
     # The `strategy` sets the deflate compression strategy.  The following
     # strategies are available:
     #
     # Zlib::DEFAULT_STRATEGY
     # :   For normal data
+    #
     # Zlib::FILTERED
     # :   For data produced by a filter or predictor
+    #
     # Zlib::FIXED
     # :   Prevents dynamic Huffman codes
+    #
     # Zlib::HUFFMAN_ONLY
     # :   Prevents string matching
+    #
     # Zlib::RLE
     # :   Designed for better compression of PNG image data
     #