rbs 3.1.3 → 3.2.0.pre.1

data/stdlib/zlib/0/zstream.rbs

@@ -0,0 +1,270 @@
+# <!-- 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
+#
+module Zlib
+  # <!-- rdoc-file=ext/zlib/zlib.c -->
+  # Zlib::ZStream is the abstract class for the stream which handles the
+  # compressed data. The operations are defined in the subclasses: Zlib::Deflate
+  # for compression, and Zlib::Inflate for decompression.
+  #
+  # An instance of Zlib::ZStream has one stream (struct zstream in the source) and
+  # two variable-length buffers which associated to the input (next_in) of the
+  # stream and the output (next_out) of the stream. In this document, "input
+  # buffer" means the buffer for input, and "output buffer" means the buffer for
+  # output.
+  #
+  # Data input into an instance of Zlib::ZStream are temporally stored into the
+  # end of input buffer, and then data in input buffer are processed from the
+  # beginning of the buffer until no more output from the stream is produced (i.e.
+  # until avail_out > 0 after processing).  During processing, output buffer is
+  # allocated and expanded automatically to hold all output data.
+  #
+  # Some particular instance methods consume the data in output buffer and return
+  # them as a String.
+  #
+  # Here is an ascii art for describing above:
+  #
+  #     +================ an instance of Zlib::ZStream ================+
+  #     ||                                                            ||
+  #     ||     +--------+          +-------+          +--------+      ||
+  #     ||  +--| output |<---------|zstream|<---------| input  |<--+  ||
+  #     ||  |  | buffer |  next_out+-------+next_in   | buffer |   |  ||
+  #     ||  |  +--------+                             +--------+   |  ||
+  #     ||  |                                                      |  ||
+  #     +===|======================================================|===+
+  #         |                                                      |
+  #         v                                                      |
+  #     "output data"                                         "input data"
+  #
+  # If an error occurs during processing input buffer, an exception which is a
+  # subclass of Zlib::Error is raised.  At that time, both input and output buffer
+  # keep their conditions at the time when the error occurs.
+  #
+  # ## Method Catalogue
+  #
+  # Many of the methods in this class are fairly low-level and unlikely to be of
+  # interest to users.  In fact, users are unlikely to use this class directly;
+  # rather they will be interested in Zlib::Inflate and Zlib::Deflate.
+  #
+  # The higher level methods are listed below.
+  #
+  # *   #total_in
+  # *   #total_out
+  # *   #data_type
+  # *   #adler
+  # *   #reset
+  # *   #finish
+  # *   #finished?
+  # *   #close
+  # *   #closed?
+  #
+  class ZStream
+    public
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - adler()
+    # -->
+    # Returns the adler-32 checksum.
+    #
+    def adler: () -> Integer
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - avail_in()
+    # -->
+    # Returns bytes of data in the input buffer. Normally, returns 0.
+    #
+    def avail_in: () -> Integer
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - avail_out()
+    # -->
+    # Returns number of bytes of free spaces in output buffer.  Because the free
+    # space is allocated automatically, this method returns 0 normally.
+    #
+    def avail_out: () -> Integer
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - avail_out=(p1)
+    # -->
+    # Allocates `size` bytes of free space in the output buffer. If there are more
+    # than `size` bytes already in the buffer, the buffer is truncated. Because free
+    # space is allocated automatically, you usually don't need to use this method.
+    #
+    def avail_out=: (Integer p1) -> void
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - close()
+    # -->
+    # Closes the stream. All operations on the closed stream will raise an
+    # exception.
+    #
+    def close: () -> void
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - closed?()
+    # -->
+    # Returns true if the stream is closed.
+    #
+    def closed?: () -> bool
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - data_type()
+    # -->
+    # Guesses the type of the data which have been inputed into the stream. The
+    # returned value is either `BINARY`, `ASCII`, or `UNKNOWN`.
+    #
+    def data_type: () -> String
+
+    # <!-- rdoc-file=ext/zlib/zlib.c -->
+    # Closes the stream. All operations on the closed stream will raise an
+    # exception.
+    #
+    def end: () -> void
+
+    # <!-- rdoc-file=ext/zlib/zlib.c -->
+    # Returns true if the stream is closed.
+    #
+    def ended?: () -> bool
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - finish                 -> String
+    #   - finish { |chunk| ... } -> nil
+    # -->
+    # Finishes the stream and flushes output buffer.  If a block is given each chunk
+    # is yielded to the block until the input buffer has been flushed to the output
+    # buffer.
+    #
+    def finish: () -> void
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - finished?()
+    # -->
+    # Returns true if the stream is finished.
+    #
+    def finished?: () -> bool
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - flush_next_in -> input
+    # -->
+    #
+    def flush_next_in: () -> String
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - flush_next_out                 -> String
+    #   - flush_next_out { |chunk| ... } -> nil
+    # -->
+    # Flushes output buffer and returns all data in that buffer.  If a block is
+    # given each chunk is yielded to the block until the current output buffer has
+    # been flushed.
+    #
+    def flush_next_out: () -> String?
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - reset()
+    # -->
+    # Resets and initializes the stream. All data in both input and output buffer
+    # are discarded.
+    #
+    def reset: () -> void
+
+    # <!-- rdoc-file=ext/zlib/zlib.c -->
+    # Returns true if the stream is finished.
+    #
+    def stream_end?: () -> bool
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - total_in()
+    # -->
+    # Returns the total bytes of the input data to the stream.  FIXME
+    #
+    def total_in: () -> Integer
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - total_out()
+    # -->
+    # Returns the total bytes of the output data from the stream.  FIXME
+    #
+    def total_out: () -> Integer
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.2.0.pre.1
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-31 00:00:00.000000000 Z
+date: 2023-08-18 00:00:00.000000000 Z
 dependencies: []
 description: RBS is the language for type signatures for Ruby and standard library
   definitions.
@@ -374,14 +374,12 @@ files:
 - stdlib/net-http/0/net-http.rbs
 - stdlib/nkf/0/nkf.rbs
 - stdlib/objspace/0/objspace.rbs
+- stdlib/observable/0/observable.rbs
 - stdlib/openssl/0/manifest.yaml
 - stdlib/openssl/0/openssl.rbs
 - stdlib/optparse/0/optparse.rbs
 - stdlib/pathname/0/pathname.rbs
 - stdlib/prettyprint/0/prettyprint.rbs
-- stdlib/prime/0/integer-extension.rbs
-- stdlib/prime/0/manifest.yaml
-- stdlib/prime/0/prime.rbs
 - stdlib/pstore/0/pstore.rbs
 - stdlib/pty/0/pty.rbs
 - stdlib/rdoc/0/rdoc.rbs
@@ -427,7 +425,25 @@ files:
 - stdlib/yaml/0/manifest.yaml
 - stdlib/yaml/0/store.rbs
 - stdlib/yaml/0/yaml.rbs
+- stdlib/zlib/0/buf_error.rbs
+- stdlib/zlib/0/data_error.rbs
+- stdlib/zlib/0/deflate.rbs
+- stdlib/zlib/0/error.rbs
+- stdlib/zlib/0/gzip_file.rbs
+- stdlib/zlib/0/gzip_file/crc_error.rbs
+- stdlib/zlib/0/gzip_file/error.rbs
+- stdlib/zlib/0/gzip_file/length_error.rbs
+- stdlib/zlib/0/gzip_file/no_footer.rbs
+- stdlib/zlib/0/gzip_reader.rbs
+- stdlib/zlib/0/gzip_writer.rbs
+- stdlib/zlib/0/inflate.rbs
+- stdlib/zlib/0/mem_error.rbs
+- stdlib/zlib/0/need_dict.rbs
+- stdlib/zlib/0/stream_end.rbs
+- stdlib/zlib/0/stream_error.rbs
+- stdlib/zlib/0/version_error.rbs
 - stdlib/zlib/0/zlib.rbs
+- stdlib/zlib/0/zstream.rbs
 homepage: https://github.com/ruby/rbs
 licenses:
 - BSD-2-Clause
@@ -444,12 +460,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.10
 signing_key:

data/stdlib/prime/0/integer-extension.rbs

@@ -1,41 +0,0 @@
-%a{annotate:rdoc:skip}
-class Integer
-  # <!--
-  #   rdoc-file=lib/prime.rb
-  #   - each_prime(ubound) { |prime| ... }
-  # -->
-  # Iterates the given block over all prime numbers.
-  #
-  # See `Prime`#each for more details.
-  #
-  def self.each_prime: (Integer) { (Integer) -> void } -> void
-
-  # <!--
-  #   rdoc-file=lib/prime.rb
-  #   - from_prime_division(pd)
-  # -->
-  # Re-composes a prime factorization and returns the product.
-  #
-  # See Prime#int_from_prime_division for more details.
-  #
-  def self.from_prime_division: (Array[[ String ]]) -> Integer
-
-  # <!--
-  #   rdoc-file=lib/prime.rb
-  #   - prime_division(generator = Prime::Generator23.new)
-  # -->
-  # Returns the factorization of `self`.
-  #
-  # See Prime#prime_division for more details.
-  #
-  def prime_division: (?Prime::PseudoPrimeGenerator) -> Array[[ Integer, Integer ]]
-
-  # <!--
-  #   rdoc-file=lib/prime.rb
-  #   - prime?()
-  # -->
-  # Returns true if `self` is a prime number, else returns false. Not recommended
-  # for very big integers (> 10**23).
-  #
-  def prime?: () -> bool
-end

data/stdlib/prime/0/manifest.yaml

@@ -1,2 +0,0 @@
-dependencies:
-  - name: singleton