rbs 3.7.0 → 3.8.0.pre.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (168) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/comments.yml +3 -3
  3. data/.github/workflows/ruby.yml +7 -7
  4. data/CHANGELOG.md +52 -0
  5. data/core/array.rbs +1743 -1580
  6. data/core/basic_object.rbs +38 -35
  7. data/core/comparable.rbs +1 -1
  8. data/core/complex.rbs +165 -93
  9. data/core/data.rbs +1 -1
  10. data/core/dir.rbs +1 -17
  11. data/core/encoding.rbs +12 -6
  12. data/core/enumerable.rbs +270 -266
  13. data/core/enumerator.rbs +0 -2
  14. data/core/env.rbs +1 -1
  15. data/core/errno.rbs +33 -16
  16. data/core/errors.rbs +2 -2
  17. data/core/exception.rbs +236 -170
  18. data/core/fiber.rbs +3 -2
  19. data/core/file.rbs +32 -74
  20. data/core/float.rbs +125 -72
  21. data/core/gc.rbs +138 -40
  22. data/core/hash.rbs +120 -141
  23. data/core/integer.rbs +79 -50
  24. data/core/io/buffer.rbs +49 -43
  25. data/core/io.rbs +97 -144
  26. data/core/kernel.rbs +290 -200
  27. data/core/match_data.rbs +76 -2
  28. data/core/math.rbs +0 -36
  29. data/core/module.rbs +28 -23
  30. data/core/nil_class.rbs +0 -3
  31. data/core/numeric.rbs +100 -103
  32. data/core/object.rbs +0 -4
  33. data/core/object_space/weak_key_map.rbs +3 -4
  34. data/core/object_space.rbs +3 -3
  35. data/core/proc.rbs +0 -2
  36. data/core/process.rbs +109 -57
  37. data/core/ractor.rbs +37 -4
  38. data/core/range.rbs +114 -87
  39. data/core/rational.rbs +0 -2
  40. data/core/rbs/unnamed/argf.rbs +234 -33
  41. data/core/rbs/unnamed/env_class.rbs +35 -53
  42. data/core/rbs/unnamed/random.rbs +1 -2
  43. data/core/regexp.rbs +4 -52
  44. data/core/ruby_vm.rbs +88 -9
  45. data/core/rubygems/config_file.rbs +3 -0
  46. data/core/rubygems/errors.rbs +0 -5
  47. data/core/rubygems/platform.rbs +0 -9
  48. data/core/rubygems/rubygems.rbs +0 -5
  49. data/core/rubygems/version.rbs +6 -6
  50. data/core/set.rbs +3 -15
  51. data/core/string.rbs +130 -136
  52. data/core/struct.rbs +6 -18
  53. data/core/symbol.rbs +14 -21
  54. data/core/thread.rbs +32 -35
  55. data/core/time.rbs +127 -50
  56. data/core/trace_point.rbs +16 -0
  57. data/core/true_class.rbs +0 -1
  58. data/core/warning.rbs +9 -2
  59. data/docs/architecture.md +1 -1
  60. data/docs/syntax.md +1 -1
  61. data/ext/rbs_extension/location.c +29 -19
  62. data/ext/rbs_extension/parser.c +267 -292
  63. data/ext/rbs_extension/parserstate.c +56 -22
  64. data/lib/rbs/annotate/annotations.rb +3 -3
  65. data/lib/rbs/annotate/rdoc_source.rb +2 -2
  66. data/lib/rbs/cli/diff.rb +3 -3
  67. data/lib/rbs/cli/validate.rb +1 -1
  68. data/lib/rbs/cli.rb +13 -13
  69. data/lib/rbs/collection/config.rb +3 -1
  70. data/lib/rbs/definition_builder/ancestor_builder.rb +3 -3
  71. data/lib/rbs/environment_loader.rb +1 -1
  72. data/lib/rbs/namespace.rb +1 -0
  73. data/lib/rbs/parser_aux.rb +2 -2
  74. data/lib/rbs/prototype/rb.rb +11 -8
  75. data/lib/rbs/prototype/rbi.rb +9 -5
  76. data/lib/rbs/prototype/runtime/value_object_generator.rb +7 -5
  77. data/lib/rbs/prototype/runtime.rb +4 -5
  78. data/lib/rbs/type_name.rb +14 -9
  79. data/lib/rbs/unit_test/type_assertions.rb +2 -2
  80. data/lib/rbs/validator.rb +3 -1
  81. data/lib/rbs/version.rb +1 -1
  82. data/lib/rdoc_plugin/parser.rb +2 -2
  83. data/rbs.gemspec +4 -0
  84. data/sig/ancestor_graph.rbs +4 -4
  85. data/sig/namespace.rbs +2 -3
  86. data/sig/resolver/constant_resolver.rbs +2 -2
  87. data/sig/resolver/context.rbs +1 -1
  88. data/sig/type_alias_regularity.rbs +5 -5
  89. data/sig/typename.rbs +8 -5
  90. data/sig/use_map.rbs +1 -1
  91. data/sig/validator.rbs +2 -2
  92. data/stdlib/base64/0/base64.rbs +0 -9
  93. data/stdlib/benchmark/0/benchmark.rbs +11 -2
  94. data/stdlib/bigdecimal/0/big_decimal.rbs +26 -182
  95. data/stdlib/cgi/0/core.rbs +47 -0
  96. data/stdlib/coverage/0/coverage.rbs +0 -3
  97. data/stdlib/csv/0/csv.rbs +18 -58
  98. data/stdlib/date/0/date.rbs +4 -19
  99. data/stdlib/did_you_mean/0/did_you_mean.rbs +0 -5
  100. data/stdlib/digest/0/digest.rbs +25 -2
  101. data/stdlib/erb/0/erb.rbs +0 -1
  102. data/stdlib/etc/0/etc.rbs +51 -34
  103. data/stdlib/fileutils/0/fileutils.rbs +3 -44
  104. data/stdlib/io-console/0/io-console.rbs +69 -15
  105. data/stdlib/ipaddr/0/ipaddr.rbs +8 -4
  106. data/stdlib/json/0/json.rbs +56 -71
  107. data/stdlib/logger/0/log_device.rbs +1 -1
  108. data/stdlib/logger/0/logger.rbs +3 -18
  109. data/stdlib/net-http/0/net-http.rbs +19 -77
  110. data/stdlib/nkf/0/nkf.rbs +30 -0
  111. data/stdlib/objspace/0/objspace.rbs +1 -2
  112. data/stdlib/observable/0/observable.rbs +1 -1
  113. data/stdlib/open-uri/0/open-uri.rbs +52 -0
  114. data/stdlib/open3/0/open3.rbs +0 -8
  115. data/stdlib/openssl/0/openssl.rbs +136 -69
  116. data/stdlib/optparse/0/optparse.rbs +58 -18
  117. data/stdlib/pathname/0/pathname.rbs +2 -8
  118. data/stdlib/pp/0/pp.rbs +3 -1
  119. data/stdlib/prettyprint/0/prettyprint.rbs +0 -4
  120. data/stdlib/pstore/0/pstore.rbs +0 -6
  121. data/stdlib/psych/0/psych.rbs +15 -4
  122. data/stdlib/pty/0/pty.rbs +46 -4
  123. data/stdlib/rdoc/0/code_object.rbs +0 -4
  124. data/stdlib/rdoc/0/markup.rbs +10 -12
  125. data/stdlib/rdoc/0/rdoc.rbs +1 -2
  126. data/stdlib/resolv/0/resolv.rbs +8 -3
  127. data/stdlib/ripper/0/ripper.rbs +0 -2
  128. data/stdlib/securerandom/0/securerandom.rbs +0 -2
  129. data/stdlib/shellwords/0/shellwords.rbs +11 -12
  130. data/stdlib/singleton/0/singleton.rbs +0 -1
  131. data/stdlib/socket/0/addrinfo.rbs +0 -1
  132. data/stdlib/socket/0/basic_socket.rbs +0 -5
  133. data/stdlib/socket/0/socket.rbs +49 -25
  134. data/stdlib/socket/0/tcp_server.rbs +0 -3
  135. data/stdlib/socket/0/tcp_socket.rbs +58 -3
  136. data/stdlib/socket/0/udp_socket.rbs +0 -1
  137. data/stdlib/socket/0/unix_server.rbs +0 -3
  138. data/stdlib/strscan/0/string_scanner.rbs +1265 -422
  139. data/stdlib/tempfile/0/tempfile.rbs +135 -28
  140. data/stdlib/time/0/time.rbs +48 -35
  141. data/stdlib/timeout/0/timeout.rbs +11 -8
  142. data/stdlib/tmpdir/0/tmpdir.rbs +8 -1
  143. data/stdlib/tsort/0/tsort.rbs +0 -4
  144. data/stdlib/uri/0/common.rbs +11 -30
  145. data/stdlib/uri/0/ftp.rbs +1 -1
  146. data/stdlib/uri/0/generic.rbs +22 -18
  147. data/stdlib/uri/0/http.rbs +2 -2
  148. data/stdlib/uri/0/rfc2396_parser.rbs +3 -0
  149. data/stdlib/zlib/0/buf_error.rbs +1 -70
  150. data/stdlib/zlib/0/data_error.rbs +1 -70
  151. data/stdlib/zlib/0/deflate.rbs +8 -72
  152. data/stdlib/zlib/0/error.rbs +1 -70
  153. data/stdlib/zlib/0/gzip_file/crc_error.rbs +2 -105
  154. data/stdlib/zlib/0/gzip_file/error.rbs +2 -105
  155. data/stdlib/zlib/0/gzip_file/length_error.rbs +2 -105
  156. data/stdlib/zlib/0/gzip_file/no_footer.rbs +2 -105
  157. data/stdlib/zlib/0/gzip_file.rbs +1 -71
  158. data/stdlib/zlib/0/gzip_reader.rbs +3 -74
  159. data/stdlib/zlib/0/gzip_writer.rbs +1 -70
  160. data/stdlib/zlib/0/inflate.rbs +4 -71
  161. data/stdlib/zlib/0/mem_error.rbs +1 -70
  162. data/stdlib/zlib/0/need_dict.rbs +1 -70
  163. data/stdlib/zlib/0/stream_end.rbs +1 -70
  164. data/stdlib/zlib/0/stream_error.rbs +1 -70
  165. data/stdlib/zlib/0/version_error.rbs +1 -70
  166. data/stdlib/zlib/0/zlib.rbs +0 -2
  167. data/stdlib/zlib/0/zstream.rbs +4 -72
  168. metadata +4 -6
@@ -1,73 +1,4 @@
1
- # <!-- rdoc-file=ext/zlib/zlib.c -->
2
- # This module provides access to the [zlib library](http://zlib.net). Zlib is
3
- # designed to be a portable, free, general-purpose, legally unencumbered -- that
4
- # is, not covered by any patents -- lossless data-compression library for use on
5
- # virtually any computer hardware and operating system.
6
- #
7
- # The zlib compression library provides in-memory compression and decompression
8
- # functions, including integrity checks of the uncompressed data.
9
- #
10
- # The zlib compressed data format is described in RFC 1950, which is a wrapper
11
- # around a deflate stream which is described in RFC 1951.
12
- #
13
- # The library also supports reading and writing files in gzip (.gz) format with
14
- # an interface similar to that of IO. The gzip format is described in RFC 1952
15
- # which is also a wrapper around a deflate stream.
16
- #
17
- # The zlib format was designed to be compact and fast for use in memory and on
18
- # communications channels. The gzip format was designed for single-file
19
- # compression on file systems, has a larger header than zlib to maintain
20
- # directory information, and uses a different, slower check method than zlib.
21
- #
22
- # See your system's zlib.h for further information about zlib
23
- #
24
- # ## Sample usage
25
- #
26
- # Using the wrapper to compress strings with default parameters is quite simple:
27
- #
28
- # require "zlib"
29
- #
30
- # data_to_compress = File.read("don_quixote.txt")
31
- #
32
- # puts "Input size: #{data_to_compress.size}"
33
- # #=> Input size: 2347740
34
- #
35
- # data_compressed = Zlib::Deflate.deflate(data_to_compress)
36
- #
37
- # puts "Compressed size: #{data_compressed.size}"
38
- # #=> Compressed size: 887238
39
- #
40
- # uncompressed_data = Zlib::Inflate.inflate(data_compressed)
41
- #
42
- # puts "Uncompressed data is: #{uncompressed_data}"
43
- # #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
44
- #
45
- # ## Class tree
46
- #
47
- # * Zlib::Deflate
48
- # * Zlib::Inflate
49
- # * Zlib::ZStream
50
- # * Zlib::Error
51
- # * Zlib::StreamEnd
52
- # * Zlib::NeedDict
53
- # * Zlib::DataError
54
- # * Zlib::StreamError
55
- # * Zlib::MemError
56
- # * Zlib::BufError
57
- # * Zlib::VersionError
58
- # * Zlib::InProgressError
59
- #
60
- #
61
- #
62
- # (if you have GZIP_SUPPORT)
63
- # * Zlib::GzipReader
64
- # * Zlib::GzipWriter
65
- # * Zlib::GzipFile
66
- # * Zlib::GzipFile::Error
67
- # * Zlib::GzipFile::LengthError
68
- # * Zlib::GzipFile::CRCError
69
- # * Zlib::GzipFile::NoFooter
70
- #
1
+ %a{annotate:rdoc:skip}
71
2
  module Zlib
72
3
  # <!-- rdoc-file=ext/zlib/zlib.c -->
73
4
  # Zlib::GzipWriter is a class for writing gzipped files. GzipWriter should be
@@ -1,73 +1,4 @@
1
- # <!-- rdoc-file=ext/zlib/zlib.c -->
2
- # This module provides access to the [zlib library](http://zlib.net). Zlib is
3
- # designed to be a portable, free, general-purpose, legally unencumbered -- that
4
- # is, not covered by any patents -- lossless data-compression library for use on
5
- # virtually any computer hardware and operating system.
6
- #
7
- # The zlib compression library provides in-memory compression and decompression
8
- # functions, including integrity checks of the uncompressed data.
9
- #
10
- # The zlib compressed data format is described in RFC 1950, which is a wrapper
11
- # around a deflate stream which is described in RFC 1951.
12
- #
13
- # The library also supports reading and writing files in gzip (.gz) format with
14
- # an interface similar to that of IO. The gzip format is described in RFC 1952
15
- # which is also a wrapper around a deflate stream.
16
- #
17
- # The zlib format was designed to be compact and fast for use in memory and on
18
- # communications channels. The gzip format was designed for single-file
19
- # compression on file systems, has a larger header than zlib to maintain
20
- # directory information, and uses a different, slower check method than zlib.
21
- #
22
- # See your system's zlib.h for further information about zlib
23
- #
24
- # ## Sample usage
25
- #
26
- # Using the wrapper to compress strings with default parameters is quite simple:
27
- #
28
- # require "zlib"
29
- #
30
- # data_to_compress = File.read("don_quixote.txt")
31
- #
32
- # puts "Input size: #{data_to_compress.size}"
33
- # #=> Input size: 2347740
34
- #
35
- # data_compressed = Zlib::Deflate.deflate(data_to_compress)
36
- #
37
- # puts "Compressed size: #{data_compressed.size}"
38
- # #=> Compressed size: 887238
39
- #
40
- # uncompressed_data = Zlib::Inflate.inflate(data_compressed)
41
- #
42
- # puts "Uncompressed data is: #{uncompressed_data}"
43
- # #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
44
- #
45
- # ## Class tree
46
- #
47
- # * Zlib::Deflate
48
- # * Zlib::Inflate
49
- # * Zlib::ZStream
50
- # * Zlib::Error
51
- # * Zlib::StreamEnd
52
- # * Zlib::NeedDict
53
- # * Zlib::DataError
54
- # * Zlib::StreamError
55
- # * Zlib::MemError
56
- # * Zlib::BufError
57
- # * Zlib::VersionError
58
- # * Zlib::InProgressError
59
- #
60
- #
61
- #
62
- # (if you have GZIP_SUPPORT)
63
- # * Zlib::GzipReader
64
- # * Zlib::GzipWriter
65
- # * Zlib::GzipFile
66
- # * Zlib::GzipFile::Error
67
- # * Zlib::GzipFile::LengthError
68
- # * Zlib::GzipFile::CRCError
69
- # * Zlib::GzipFile::NoFooter
70
- #
1
+ %a{annotate:rdoc:skip}
71
2
  module Zlib
72
3
  # <!-- rdoc-file=ext/zlib/zlib.c -->
73
4
  # Zlib:Inflate is the class for decompressing compressed data. Unlike
@@ -138,7 +69,6 @@ module Zlib
138
69
  # * When passing a block, the yielded chunks will be the same value as the
139
70
  # :buffer keyword argument.
140
71
  #
141
- #
142
72
  # Raises a Zlib::NeedDict exception if a preset dictionary is needed to
143
73
  # decompress. Set the dictionary by Zlib::Inflate#set_dictionary and then call
144
74
  # this method again with an empty string to flush the stream:
@@ -210,16 +140,19 @@ module Zlib
210
140
  # : Have inflate use the window size from the zlib header of the compressed
211
141
  # stream.
212
142
  #
143
+ #
213
144
  # (8..15)
214
145
  # : Overrides the window size of the inflate header in the compressed stream.
215
146
  # The window size must be greater than or equal to the window size of the
216
147
  # compressed stream.
217
148
  #
149
+ #
218
150
  # Greater than 15
219
151
  # : Add 32 to window_bits to enable zlib and gzip decoding with automatic
220
152
  # header detection, or add 16 to decode only the gzip format (a
221
153
  # Zlib::DataError will be raised for a non-gzip stream).
222
154
  #
155
+ #
223
156
  # (-8..-15)
224
157
  # : Enables raw deflate mode which will not generate a check value, and will
225
158
  # not look for any check values for comparison at the end of the stream.
@@ -1,73 +1,4 @@
1
- # <!-- rdoc-file=ext/zlib/zlib.c -->
2
- # This module provides access to the [zlib library](http://zlib.net). Zlib is
3
- # designed to be a portable, free, general-purpose, legally unencumbered -- that
4
- # is, not covered by any patents -- lossless data-compression library for use on
5
- # virtually any computer hardware and operating system.
6
- #
7
- # The zlib compression library provides in-memory compression and decompression
8
- # functions, including integrity checks of the uncompressed data.
9
- #
10
- # The zlib compressed data format is described in RFC 1950, which is a wrapper
11
- # around a deflate stream which is described in RFC 1951.
12
- #
13
- # The library also supports reading and writing files in gzip (.gz) format with
14
- # an interface similar to that of IO. The gzip format is described in RFC 1952
15
- # which is also a wrapper around a deflate stream.
16
- #
17
- # The zlib format was designed to be compact and fast for use in memory and on
18
- # communications channels. The gzip format was designed for single-file
19
- # compression on file systems, has a larger header than zlib to maintain
20
- # directory information, and uses a different, slower check method than zlib.
21
- #
22
- # See your system's zlib.h for further information about zlib
23
- #
24
- # ## Sample usage
25
- #
26
- # Using the wrapper to compress strings with default parameters is quite simple:
27
- #
28
- # require "zlib"
29
- #
30
- # data_to_compress = File.read("don_quixote.txt")
31
- #
32
- # puts "Input size: #{data_to_compress.size}"
33
- # #=> Input size: 2347740
34
- #
35
- # data_compressed = Zlib::Deflate.deflate(data_to_compress)
36
- #
37
- # puts "Compressed size: #{data_compressed.size}"
38
- # #=> Compressed size: 887238
39
- #
40
- # uncompressed_data = Zlib::Inflate.inflate(data_compressed)
41
- #
42
- # puts "Uncompressed data is: #{uncompressed_data}"
43
- # #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
44
- #
45
- # ## Class tree
46
- #
47
- # * Zlib::Deflate
48
- # * Zlib::Inflate
49
- # * Zlib::ZStream
50
- # * Zlib::Error
51
- # * Zlib::StreamEnd
52
- # * Zlib::NeedDict
53
- # * Zlib::DataError
54
- # * Zlib::StreamError
55
- # * Zlib::MemError
56
- # * Zlib::BufError
57
- # * Zlib::VersionError
58
- # * Zlib::InProgressError
59
- #
60
- #
61
- #
62
- # (if you have GZIP_SUPPORT)
63
- # * Zlib::GzipReader
64
- # * Zlib::GzipWriter
65
- # * Zlib::GzipFile
66
- # * Zlib::GzipFile::Error
67
- # * Zlib::GzipFile::LengthError
68
- # * Zlib::GzipFile::CRCError
69
- # * Zlib::GzipFile::NoFooter
70
- #
1
+ %a{annotate:rdoc:skip}
71
2
  module Zlib
72
3
  # <!-- rdoc-file=ext/zlib/zlib.c -->
73
4
  # Subclass of Zlib::Error
@@ -1,73 +1,4 @@
1
- # <!-- rdoc-file=ext/zlib/zlib.c -->
2
- # This module provides access to the [zlib library](http://zlib.net). Zlib is
3
- # designed to be a portable, free, general-purpose, legally unencumbered -- that
4
- # is, not covered by any patents -- lossless data-compression library for use on
5
- # virtually any computer hardware and operating system.
6
- #
7
- # The zlib compression library provides in-memory compression and decompression
8
- # functions, including integrity checks of the uncompressed data.
9
- #
10
- # The zlib compressed data format is described in RFC 1950, which is a wrapper
11
- # around a deflate stream which is described in RFC 1951.
12
- #
13
- # The library also supports reading and writing files in gzip (.gz) format with
14
- # an interface similar to that of IO. The gzip format is described in RFC 1952
15
- # which is also a wrapper around a deflate stream.
16
- #
17
- # The zlib format was designed to be compact and fast for use in memory and on
18
- # communications channels. The gzip format was designed for single-file
19
- # compression on file systems, has a larger header than zlib to maintain
20
- # directory information, and uses a different, slower check method than zlib.
21
- #
22
- # See your system's zlib.h for further information about zlib
23
- #
24
- # ## Sample usage
25
- #
26
- # Using the wrapper to compress strings with default parameters is quite simple:
27
- #
28
- # require "zlib"
29
- #
30
- # data_to_compress = File.read("don_quixote.txt")
31
- #
32
- # puts "Input size: #{data_to_compress.size}"
33
- # #=> Input size: 2347740
34
- #
35
- # data_compressed = Zlib::Deflate.deflate(data_to_compress)
36
- #
37
- # puts "Compressed size: #{data_compressed.size}"
38
- # #=> Compressed size: 887238
39
- #
40
- # uncompressed_data = Zlib::Inflate.inflate(data_compressed)
41
- #
42
- # puts "Uncompressed data is: #{uncompressed_data}"
43
- # #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
44
- #
45
- # ## Class tree
46
- #
47
- # * Zlib::Deflate
48
- # * Zlib::Inflate
49
- # * Zlib::ZStream
50
- # * Zlib::Error
51
- # * Zlib::StreamEnd
52
- # * Zlib::NeedDict
53
- # * Zlib::DataError
54
- # * Zlib::StreamError
55
- # * Zlib::MemError
56
- # * Zlib::BufError
57
- # * Zlib::VersionError
58
- # * Zlib::InProgressError
59
- #
60
- #
61
- #
62
- # (if you have GZIP_SUPPORT)
63
- # * Zlib::GzipReader
64
- # * Zlib::GzipWriter
65
- # * Zlib::GzipFile
66
- # * Zlib::GzipFile::Error
67
- # * Zlib::GzipFile::LengthError
68
- # * Zlib::GzipFile::CRCError
69
- # * Zlib::GzipFile::NoFooter
70
- #
1
+ %a{annotate:rdoc:skip}
71
2
  module Zlib
72
3
  # <!-- rdoc-file=ext/zlib/zlib.c -->
73
4
  # Subclass of Zlib::Error
@@ -1,73 +1,4 @@
1
- # <!-- rdoc-file=ext/zlib/zlib.c -->
2
- # This module provides access to the [zlib library](http://zlib.net). Zlib is
3
- # designed to be a portable, free, general-purpose, legally unencumbered -- that
4
- # is, not covered by any patents -- lossless data-compression library for use on
5
- # virtually any computer hardware and operating system.
6
- #
7
- # The zlib compression library provides in-memory compression and decompression
8
- # functions, including integrity checks of the uncompressed data.
9
- #
10
- # The zlib compressed data format is described in RFC 1950, which is a wrapper
11
- # around a deflate stream which is described in RFC 1951.
12
- #
13
- # The library also supports reading and writing files in gzip (.gz) format with
14
- # an interface similar to that of IO. The gzip format is described in RFC 1952
15
- # which is also a wrapper around a deflate stream.
16
- #
17
- # The zlib format was designed to be compact and fast for use in memory and on
18
- # communications channels. The gzip format was designed for single-file
19
- # compression on file systems, has a larger header than zlib to maintain
20
- # directory information, and uses a different, slower check method than zlib.
21
- #
22
- # See your system's zlib.h for further information about zlib
23
- #
24
- # ## Sample usage
25
- #
26
- # Using the wrapper to compress strings with default parameters is quite simple:
27
- #
28
- # require "zlib"
29
- #
30
- # data_to_compress = File.read("don_quixote.txt")
31
- #
32
- # puts "Input size: #{data_to_compress.size}"
33
- # #=> Input size: 2347740
34
- #
35
- # data_compressed = Zlib::Deflate.deflate(data_to_compress)
36
- #
37
- # puts "Compressed size: #{data_compressed.size}"
38
- # #=> Compressed size: 887238
39
- #
40
- # uncompressed_data = Zlib::Inflate.inflate(data_compressed)
41
- #
42
- # puts "Uncompressed data is: #{uncompressed_data}"
43
- # #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
44
- #
45
- # ## Class tree
46
- #
47
- # * Zlib::Deflate
48
- # * Zlib::Inflate
49
- # * Zlib::ZStream
50
- # * Zlib::Error
51
- # * Zlib::StreamEnd
52
- # * Zlib::NeedDict
53
- # * Zlib::DataError
54
- # * Zlib::StreamError
55
- # * Zlib::MemError
56
- # * Zlib::BufError
57
- # * Zlib::VersionError
58
- # * Zlib::InProgressError
59
- #
60
- #
61
- #
62
- # (if you have GZIP_SUPPORT)
63
- # * Zlib::GzipReader
64
- # * Zlib::GzipWriter
65
- # * Zlib::GzipFile
66
- # * Zlib::GzipFile::Error
67
- # * Zlib::GzipFile::LengthError
68
- # * Zlib::GzipFile::CRCError
69
- # * Zlib::GzipFile::NoFooter
70
- #
1
+ %a{annotate:rdoc:skip}
71
2
  module Zlib
72
3
  # <!-- rdoc-file=ext/zlib/zlib.c -->
73
4
  # Subclass of Zlib::Error
@@ -1,73 +1,4 @@
1
- # <!-- rdoc-file=ext/zlib/zlib.c -->
2
- # This module provides access to the [zlib library](http://zlib.net). Zlib is
3
- # designed to be a portable, free, general-purpose, legally unencumbered -- that
4
- # is, not covered by any patents -- lossless data-compression library for use on
5
- # virtually any computer hardware and operating system.
6
- #
7
- # The zlib compression library provides in-memory compression and decompression
8
- # functions, including integrity checks of the uncompressed data.
9
- #
10
- # The zlib compressed data format is described in RFC 1950, which is a wrapper
11
- # around a deflate stream which is described in RFC 1951.
12
- #
13
- # The library also supports reading and writing files in gzip (.gz) format with
14
- # an interface similar to that of IO. The gzip format is described in RFC 1952
15
- # which is also a wrapper around a deflate stream.
16
- #
17
- # The zlib format was designed to be compact and fast for use in memory and on
18
- # communications channels. The gzip format was designed for single-file
19
- # compression on file systems, has a larger header than zlib to maintain
20
- # directory information, and uses a different, slower check method than zlib.
21
- #
22
- # See your system's zlib.h for further information about zlib
23
- #
24
- # ## Sample usage
25
- #
26
- # Using the wrapper to compress strings with default parameters is quite simple:
27
- #
28
- # require "zlib"
29
- #
30
- # data_to_compress = File.read("don_quixote.txt")
31
- #
32
- # puts "Input size: #{data_to_compress.size}"
33
- # #=> Input size: 2347740
34
- #
35
- # data_compressed = Zlib::Deflate.deflate(data_to_compress)
36
- #
37
- # puts "Compressed size: #{data_compressed.size}"
38
- # #=> Compressed size: 887238
39
- #
40
- # uncompressed_data = Zlib::Inflate.inflate(data_compressed)
41
- #
42
- # puts "Uncompressed data is: #{uncompressed_data}"
43
- # #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
44
- #
45
- # ## Class tree
46
- #
47
- # * Zlib::Deflate
48
- # * Zlib::Inflate
49
- # * Zlib::ZStream
50
- # * Zlib::Error
51
- # * Zlib::StreamEnd
52
- # * Zlib::NeedDict
53
- # * Zlib::DataError
54
- # * Zlib::StreamError
55
- # * Zlib::MemError
56
- # * Zlib::BufError
57
- # * Zlib::VersionError
58
- # * Zlib::InProgressError
59
- #
60
- #
61
- #
62
- # (if you have GZIP_SUPPORT)
63
- # * Zlib::GzipReader
64
- # * Zlib::GzipWriter
65
- # * Zlib::GzipFile
66
- # * Zlib::GzipFile::Error
67
- # * Zlib::GzipFile::LengthError
68
- # * Zlib::GzipFile::CRCError
69
- # * Zlib::GzipFile::NoFooter
70
- #
1
+ %a{annotate:rdoc:skip}
71
2
  module Zlib
72
3
  # <!-- rdoc-file=ext/zlib/zlib.c -->
73
4
  # Subclass of Zlib::Error
@@ -1,73 +1,4 @@
1
- # <!-- rdoc-file=ext/zlib/zlib.c -->
2
- # This module provides access to the [zlib library](http://zlib.net). Zlib is
3
- # designed to be a portable, free, general-purpose, legally unencumbered -- that
4
- # is, not covered by any patents -- lossless data-compression library for use on
5
- # virtually any computer hardware and operating system.
6
- #
7
- # The zlib compression library provides in-memory compression and decompression
8
- # functions, including integrity checks of the uncompressed data.
9
- #
10
- # The zlib compressed data format is described in RFC 1950, which is a wrapper
11
- # around a deflate stream which is described in RFC 1951.
12
- #
13
- # The library also supports reading and writing files in gzip (.gz) format with
14
- # an interface similar to that of IO. The gzip format is described in RFC 1952
15
- # which is also a wrapper around a deflate stream.
16
- #
17
- # The zlib format was designed to be compact and fast for use in memory and on
18
- # communications channels. The gzip format was designed for single-file
19
- # compression on file systems, has a larger header than zlib to maintain
20
- # directory information, and uses a different, slower check method than zlib.
21
- #
22
- # See your system's zlib.h for further information about zlib
23
- #
24
- # ## Sample usage
25
- #
26
- # Using the wrapper to compress strings with default parameters is quite simple:
27
- #
28
- # require "zlib"
29
- #
30
- # data_to_compress = File.read("don_quixote.txt")
31
- #
32
- # puts "Input size: #{data_to_compress.size}"
33
- # #=> Input size: 2347740
34
- #
35
- # data_compressed = Zlib::Deflate.deflate(data_to_compress)
36
- #
37
- # puts "Compressed size: #{data_compressed.size}"
38
- # #=> Compressed size: 887238
39
- #
40
- # uncompressed_data = Zlib::Inflate.inflate(data_compressed)
41
- #
42
- # puts "Uncompressed data is: #{uncompressed_data}"
43
- # #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
44
- #
45
- # ## Class tree
46
- #
47
- # * Zlib::Deflate
48
- # * Zlib::Inflate
49
- # * Zlib::ZStream
50
- # * Zlib::Error
51
- # * Zlib::StreamEnd
52
- # * Zlib::NeedDict
53
- # * Zlib::DataError
54
- # * Zlib::StreamError
55
- # * Zlib::MemError
56
- # * Zlib::BufError
57
- # * Zlib::VersionError
58
- # * Zlib::InProgressError
59
- #
60
- #
61
- #
62
- # (if you have GZIP_SUPPORT)
63
- # * Zlib::GzipReader
64
- # * Zlib::GzipWriter
65
- # * Zlib::GzipFile
66
- # * Zlib::GzipFile::Error
67
- # * Zlib::GzipFile::LengthError
68
- # * Zlib::GzipFile::CRCError
69
- # * Zlib::GzipFile::NoFooter
70
- #
1
+ %a{annotate:rdoc:skip}
71
2
  module Zlib
72
3
  # <!-- rdoc-file=ext/zlib/zlib.c -->
73
4
  # Subclass of Zlib::Error
@@ -57,8 +57,6 @@
57
57
  # * Zlib::VersionError
58
58
  # * Zlib::InProgressError
59
59
  #
60
- #
61
- #
62
60
  # (if you have GZIP_SUPPORT)
63
61
  # * Zlib::GzipReader
64
62
  # * Zlib::GzipWriter
@@ -1,73 +1,4 @@
1
- # <!-- rdoc-file=ext/zlib/zlib.c -->
2
- # This module provides access to the [zlib library](http://zlib.net). Zlib is
3
- # designed to be a portable, free, general-purpose, legally unencumbered -- that
4
- # is, not covered by any patents -- lossless data-compression library for use on
5
- # virtually any computer hardware and operating system.
6
- #
7
- # The zlib compression library provides in-memory compression and decompression
8
- # functions, including integrity checks of the uncompressed data.
9
- #
10
- # The zlib compressed data format is described in RFC 1950, which is a wrapper
11
- # around a deflate stream which is described in RFC 1951.
12
- #
13
- # The library also supports reading and writing files in gzip (.gz) format with
14
- # an interface similar to that of IO. The gzip format is described in RFC 1952
15
- # which is also a wrapper around a deflate stream.
16
- #
17
- # The zlib format was designed to be compact and fast for use in memory and on
18
- # communications channels. The gzip format was designed for single-file
19
- # compression on file systems, has a larger header than zlib to maintain
20
- # directory information, and uses a different, slower check method than zlib.
21
- #
22
- # See your system's zlib.h for further information about zlib
23
- #
24
- # ## Sample usage
25
- #
26
- # Using the wrapper to compress strings with default parameters is quite simple:
27
- #
28
- # require "zlib"
29
- #
30
- # data_to_compress = File.read("don_quixote.txt")
31
- #
32
- # puts "Input size: #{data_to_compress.size}"
33
- # #=> Input size: 2347740
34
- #
35
- # data_compressed = Zlib::Deflate.deflate(data_to_compress)
36
- #
37
- # puts "Compressed size: #{data_compressed.size}"
38
- # #=> Compressed size: 887238
39
- #
40
- # uncompressed_data = Zlib::Inflate.inflate(data_compressed)
41
- #
42
- # puts "Uncompressed data is: #{uncompressed_data}"
43
- # #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
44
- #
45
- # ## Class tree
46
- #
47
- # * Zlib::Deflate
48
- # * Zlib::Inflate
49
- # * Zlib::ZStream
50
- # * Zlib::Error
51
- # * Zlib::StreamEnd
52
- # * Zlib::NeedDict
53
- # * Zlib::DataError
54
- # * Zlib::StreamError
55
- # * Zlib::MemError
56
- # * Zlib::BufError
57
- # * Zlib::VersionError
58
- # * Zlib::InProgressError
59
- #
60
- #
61
- #
62
- # (if you have GZIP_SUPPORT)
63
- # * Zlib::GzipReader
64
- # * Zlib::GzipWriter
65
- # * Zlib::GzipFile
66
- # * Zlib::GzipFile::Error
67
- # * Zlib::GzipFile::LengthError
68
- # * Zlib::GzipFile::CRCError
69
- # * Zlib::GzipFile::NoFooter
70
- #
1
+ %a{annotate:rdoc:skip}
71
2
  module Zlib
72
3
  # <!-- rdoc-file=ext/zlib/zlib.c -->
73
4
  # Zlib::ZStream is the abstract class for the stream which handles the
@@ -182,7 +113,7 @@ module Zlib
182
113
  # rdoc-file=ext/zlib/zlib.c
183
114
  # - data_type()
184
115
  # -->
185
- # Guesses the type of the data which have been inputed into the stream. The
116
+ # Guesses the type of the data which have been inputted into the stream. The
186
117
  # returned value is either `BINARY`, `ASCII`, or `UNKNOWN`.
187
118
  #
188
119
  def data_type: () -> String
@@ -207,7 +138,8 @@ module Zlib
207
138
  # is yielded to the block until the input buffer has been flushed to the output
208
139
  # buffer.
209
140
  #
210
- def finish: () -> void
141
+ def finish: () -> String
142
+ | () { (String chunk) -> void } -> void
211
143
 
212
144
  # <!--
213
145
  # rdoc-file=ext/zlib/zlib.c
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rbs
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.7.0
4
+ version: 3.8.0.pre.1
5
5
  platform: ruby
6
+ original_platform: ''
6
7
  authors:
7
8
  - Soutaro Matsumoto
8
- autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2024-12-05 00:00:00.000000000 Z
11
+ date: 2024-12-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: logger
@@ -527,7 +527,6 @@ metadata:
527
527
  homepage_uri: https://github.com/ruby/rbs
528
528
  source_code_uri: https://github.com/ruby/rbs.git
529
529
  changelog_uri: https://github.com/ruby/rbs/blob/master/CHANGELOG.md
530
- post_install_message:
531
530
  rdoc_options: []
532
531
  require_paths:
533
532
  - lib
@@ -542,8 +541,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
542
541
  - !ruby/object:Gem::Version
543
542
  version: '0'
544
543
  requirements: []
545
- rubygems_version: 3.5.22
546
- signing_key:
544
+ rubygems_version: 3.6.0.dev
547
545
  specification_version: 4
548
546
  summary: Type signature for Ruby.
549
547
  test_files: []