rbs-relaxed 3.9.0.1

data/stdlib/zlib/0/zlib.rbs

@@ -0,0 +1,449 @@
+# <!-- 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.adler32(string, adler)
+  # -->
+  # Calculates Adler-32 checksum for `string`, and returns updated value of
+  # `adler`. If `string` is omitted, it returns the Adler-32 initial value. If
+  # `adler` is omitted, it assumes that the initial value is given to `adler`. If
+  # `string` is an IO instance, reads from the IO until the IO returns nil and
+  # returns Adler-32 of all read data.
+  #
+  # Example usage:
+  #
+  #     require "zlib"
+  #
+  #     data = "foo"
+  #     puts "Adler32 checksum: #{Zlib.adler32(data).to_s(16)}"
+  #     #=> Adler32 checksum: 2820145
+  #
+  def self.adler32: () -> Integer
+                  | (String) -> Integer
+                  | (String, Integer) -> Integer
+
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - Zlib.adler32_combine(adler1, adler2, len2)
+  # -->
+  # Combine two Adler-32 check values in to one.  `adler1` is the first Adler-32
+  # value, `adler2` is the second Adler-32 value.  `len2` is the length of the
+  # string used to generate `adler2`.
+  #
+  def self.adler32_combine: (Integer, Integer, Integer) -> Integer
+
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - Zlib.crc32(string, crc)
+  # -->
+  # Calculates CRC checksum for `string`, and returns updated value of `crc`. If
+  # `string` is omitted, it returns the CRC initial value. If `crc` is omitted, it
+  # assumes that the initial value is given to `crc`. If `string` is an IO
+  # instance, reads from the IO until the IO returns nil and returns CRC checksum
+  # of all read data.
+  #
+  # FIXME: expression.
+  #
+  def self.crc32: () -> Integer
+                | (String) -> Integer
+                | (String, Integer) -> Integer
+
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - Zlib.crc32_combine(crc1, crc2, len2)
+  # -->
+  # Combine two CRC-32 check values in to one.  `crc1` is the first CRC-32 value,
+  # `crc2` is the second CRC-32 value.  `len2` is the length of the string used to
+  # generate `crc2`.
+  #
+  def self.crc32_combine: (Integer, Integer, Integer) -> Integer
+
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - crc_table()
+  # -->
+  # Returns the table for calculating CRC checksum as an array.
+  #
+  def self.crc_table: () -> Array[Integer]
+
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - Zlib.deflate(string[, level])
+  #   - Zlib::Deflate.deflate(string[, level])
+  # -->
+  # Compresses the given `string`. Valid values of level are Zlib::NO_COMPRESSION,
+  # Zlib::BEST_SPEED, Zlib::BEST_COMPRESSION, Zlib::DEFAULT_COMPRESSION, or an
+  # integer from 0 to 9.
+  #
+  # This method is almost equivalent to the following code:
+  #
+  #     def deflate(string, level)
+  #       z = Zlib::Deflate.new(level)
+  #       dst = z.deflate(string, Zlib::FINISH)
+  #       z.close
+  #       dst
+  #     end
+  #
+  # See also Zlib.inflate
+  #
+  def self.deflate: (String) -> String
+                  | (String, Integer) -> String
+
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - Zlib.gunzip(src) -> String
+  # -->
+  # Decode the given gzipped `string`.
+  #
+  # This method is almost equivalent to the following code:
+  #
+  #     def gunzip(string)
+  #       sio = StringIO.new(string)
+  #       gz = Zlib::GzipReader.new(sio, encoding: Encoding::ASCII_8BIT)
+  #       gz.read
+  #     ensure
+  #       gz&.close
+  #     end
+  #
+  # See also Zlib.gzip
+  #
+  def self.gunzip: (String) -> String
+
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - Zlib.gzip(src, level: nil, strategy: nil) -> String
+  # -->
+  # Gzip the given `string`. Valid values of level are Zlib::NO_COMPRESSION,
+  # Zlib::BEST_SPEED, Zlib::BEST_COMPRESSION, Zlib::DEFAULT_COMPRESSION (default),
+  # or an integer from 0 to 9.
+  #
+  # This method is almost equivalent to the following code:
+  #
+  #     def gzip(string, level: nil, strategy: nil)
+  #       sio = StringIO.new
+  #       sio.binmode
+  #       gz = Zlib::GzipWriter.new(sio, level, strategy)
+  #       gz.write(string)
+  #       gz.close
+  #       sio.string
+  #     end
+  #
+  # See also Zlib.gunzip
+  #
+  def self.gzip: (String) -> String
+               | (String, level: Integer) -> String
+               | (String, strategy: Integer) -> String
+               | (String, level: Integer, strategy: Integer) -> String
+
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - Zlib.inflate(string)
+  #   - Zlib::Inflate.inflate(string)
+  # -->
+  # Decompresses `string`. Raises a Zlib::NeedDict exception if a preset
+  # dictionary is needed for decompression.
+  #
+  # This method is almost equivalent to the following code:
+  #
+  #     def inflate(string)
+  #       zstream = Zlib::Inflate.new
+  #       buf = zstream.inflate(string)
+  #       zstream.finish
+  #       zstream.close
+  #       buf
+  #     end
+  #
+  # See also Zlib.deflate
+  #
+  def self.inflate: (String) -> String
+
+  # <!--
+  #   rdoc-file=ext/zlib/zlib.c
+  #   - zlib_version()
+  # -->
+  # Returns the string which represents the version of zlib library.
+  #
+  def self.zlib_version: () -> String
+end
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# Represents text data as guessed by deflate.
+#
+# NOTE: The underlying constant Z_ASCII was deprecated in favor of Z_TEXT in
+# zlib 1.2.2.  New applications should not use this constant.
+#
+# See Zlib::Deflate#data_type.
+#
+Zlib::ASCII: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# Slowest compression level, but with the best space savings.
+#
+Zlib::BEST_COMPRESSION: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# Fastest compression level, but with the lowest space savings.
+#
+Zlib::BEST_SPEED: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# Represents binary data as guessed by deflate.
+#
+# See Zlib::Deflate#data_type.
+#
+Zlib::BINARY: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# Default compression level which is a good trade-off between space and time
+#
+Zlib::DEFAULT_COMPRESSION: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# Default deflate strategy which is used for normal data.
+#
+Zlib::DEFAULT_STRATEGY: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# The default memory level for allocating zlib deflate compression state.
+#
+Zlib::DEF_MEM_LEVEL: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# Deflate strategy for data produced by a filter (or predictor). The effect of
+# FILTERED is to force more Huffman codes and less string matching; it is
+# somewhat intermediate between DEFAULT_STRATEGY and HUFFMAN_ONLY. Filtered data
+# consists mostly of small values with a somewhat random distribution.
+#
+Zlib::FILTERED: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# Processes all pending input and flushes pending output.
+#
+Zlib::FINISH: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# Deflate strategy which prevents the use of dynamic Huffman codes, allowing for
+# a simpler decoder for specialized applications.
+#
+Zlib::FIXED: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# Flushes all output as with SYNC_FLUSH, and the compression state is reset so
+# that decompression can restart from this point if previous compressed data has
+# been damaged or if random access is desired. Like SYNC_FLUSH, using FULL_FLUSH
+# too often can seriously degrade compression.
+#
+Zlib::FULL_FLUSH: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# Deflate strategy which uses Huffman codes only (no string matching).
+#
+Zlib::HUFFMAN_ONLY: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# The maximum memory level for allocating zlib deflate compression state.
+#
+Zlib::MAX_MEM_LEVEL: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# The maximum size of the zlib history buffer.  Note that zlib allows larger
+# values to enable different inflate modes.  See Zlib::Inflate.new for details.
+#
+Zlib::MAX_WBITS: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# No compression, passes through data untouched.  Use this for appending
+# pre-compressed data to a deflate stream.
+#
+Zlib::NO_COMPRESSION: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# NO_FLUSH is the default flush method and allows deflate to decide how much
+# data to accumulate before producing output in order to maximize compression.
+#
+Zlib::NO_FLUSH: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# OS code for Amiga hosts
+#
+Zlib::OS_AMIGA: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# OS code for Atari hosts
+#
+Zlib::OS_ATARI: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# The OS code of current host
+#
+Zlib::OS_CODE: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# OS code for CP/M hosts
+#
+Zlib::OS_CPM: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# OS code for Mac OS hosts
+#
+Zlib::OS_MACOS: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# OS code for MSDOS hosts
+#
+Zlib::OS_MSDOS: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# OS code for OS2 hosts
+#
+Zlib::OS_OS2: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# OS code for QDOS hosts
+#
+Zlib::OS_QDOS: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# OS code for RISC OS hosts
+#
+Zlib::OS_RISCOS: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# OS code for TOPS-20 hosts
+#
+Zlib::OS_TOPS20: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# OS code for UNIX hosts
+#
+Zlib::OS_UNIX: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# OS code for unknown hosts
+#
+Zlib::OS_UNKNOWN: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# OS code for VM OS hosts
+#
+Zlib::OS_VMCMS: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# OS code for VMS hosts
+#
+Zlib::OS_VMS: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# OS code for Win32 hosts
+#
+Zlib::OS_WIN32: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# OS code for Z-System hosts
+#
+Zlib::OS_ZSYSTEM: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# Deflate compression strategy designed to be almost as fast as HUFFMAN_ONLY,
+# but give better compression for PNG image data.
+#
+Zlib::RLE: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# The SYNC_FLUSH method flushes all pending output to the output buffer and the
+# output is aligned on a byte boundary. Flushing may degrade compression so it
+# should be used only when necessary, such as at a request or response boundary
+# for a network stream.
+#
+Zlib::SYNC_FLUSH: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# Represents text data as guessed by deflate.
+#
+# See Zlib::Deflate#data_type.
+#
+Zlib::TEXT: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# Represents an unknown data type as guessed by deflate.
+#
+# See Zlib::Deflate#data_type.
+#
+Zlib::UNKNOWN: Integer
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# The Ruby/zlib version string.
+#
+Zlib::VERSION: String
+
+# <!-- rdoc-file=ext/zlib/zlib.c -->
+# The string which represents the version of zlib.h
+#
+Zlib::ZLIB_VERSION: String

data/stdlib/zlib/0/zstream.rbs

@@ -0,0 +1,200 @@
+%a{annotate:rdoc:skip}
+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
+    # <!--
+    #   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 inputted 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: () -> String
+              | () { (String chunk) -> void } -> 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