rbs 3.1.3 → 3.2.0.pre.1

data/stdlib/zlib/0/gzip_file/error.rbs

@@ -0,0 +1,128 @@
+# <!-- 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::GzipFile is an abstract class for handling a gzip formatted compressed
+  # file. The operations are defined in the subclasses, Zlib::GzipReader for
+  # reading, and Zlib::GzipWriter for writing.
+  #
+  # GzipReader should be used by associating an IO, or IO-like, object.
+  #
+  # ## Method Catalogue
+  #
+  # *   ::wrap
+  # *   ::open (Zlib::GzipReader::open and Zlib::GzipWriter::open)
+  # *   #close
+  # *   #closed?
+  # *   #comment
+  # *   comment= (Zlib::GzipWriter#comment=)
+  # *   #crc
+  # *   eof? (Zlib::GzipReader#eof?)
+  # *   #finish
+  # *   #level
+  # *   lineno (Zlib::GzipReader#lineno)
+  # *   lineno= (Zlib::GzipReader#lineno=)
+  # *   #mtime
+  # *   mtime= (Zlib::GzipWriter#mtime=)
+  # *   #orig_name
+  # *   orig_name (Zlib::GzipWriter#orig_name=)
+  # *   #os_code
+  # *   path (when the underlying IO supports #path)
+  # *   #sync
+  # *   #sync=
+  # *   #to_io
+  #
+  #
+  # (due to internal structure, documentation may appear under Zlib::GzipReader or
+  # Zlib::GzipWriter)
+  #
+  class GzipFile
+    # <!-- rdoc-file=ext/zlib/zlib.c -->
+    # Base class of errors that occur when processing GZIP files.
+    #
+    class Error < Zlib::Error
+      public
+
+      # <!-- rdoc-file=ext/zlib/zlib.c -->
+      # input gzipped string
+      #
+      def input: () -> String
+
+      # <!--
+      #   rdoc-file=ext/zlib/zlib.c
+      #   - inspect()
+      # -->
+      # Constructs a String of the GzipFile Error
+      #
+      def inspect: () -> String
+    end
+  end
+end

data/stdlib/zlib/0/gzip_file/length_error.rbs

@@ -0,0 +1,115 @@
+# <!-- 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::GzipFile is an abstract class for handling a gzip formatted compressed
+  # file. The operations are defined in the subclasses, Zlib::GzipReader for
+  # reading, and Zlib::GzipWriter for writing.
+  #
+  # GzipReader should be used by associating an IO, or IO-like, object.
+  #
+  # ## Method Catalogue
+  #
+  # *   ::wrap
+  # *   ::open (Zlib::GzipReader::open and Zlib::GzipWriter::open)
+  # *   #close
+  # *   #closed?
+  # *   #comment
+  # *   comment= (Zlib::GzipWriter#comment=)
+  # *   #crc
+  # *   eof? (Zlib::GzipReader#eof?)
+  # *   #finish
+  # *   #level
+  # *   lineno (Zlib::GzipReader#lineno)
+  # *   lineno= (Zlib::GzipReader#lineno=)
+  # *   #mtime
+  # *   mtime= (Zlib::GzipWriter#mtime=)
+  # *   #orig_name
+  # *   orig_name (Zlib::GzipWriter#orig_name=)
+  # *   #os_code
+  # *   path (when the underlying IO supports #path)
+  # *   #sync
+  # *   #sync=
+  # *   #to_io
+  #
+  #
+  # (due to internal structure, documentation may appear under Zlib::GzipReader or
+  # Zlib::GzipWriter)
+  #
+  class GzipFile
+    # <!-- rdoc-file=ext/zlib/zlib.c -->
+    # Raised when the data length recorded in the gzip file footer is not equivalent
+    # to the length of the actual uncompressed data.
+    #
+    class LengthError < Zlib::GzipFile::Error
+    end
+  end
+end

data/stdlib/zlib/0/gzip_file/no_footer.rbs

@@ -0,0 +1,114 @@
+# <!-- 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::GzipFile is an abstract class for handling a gzip formatted compressed
+  # file. The operations are defined in the subclasses, Zlib::GzipReader for
+  # reading, and Zlib::GzipWriter for writing.
+  #
+  # GzipReader should be used by associating an IO, or IO-like, object.
+  #
+  # ## Method Catalogue
+  #
+  # *   ::wrap
+  # *   ::open (Zlib::GzipReader::open and Zlib::GzipWriter::open)
+  # *   #close
+  # *   #closed?
+  # *   #comment
+  # *   comment= (Zlib::GzipWriter#comment=)
+  # *   #crc
+  # *   eof? (Zlib::GzipReader#eof?)
+  # *   #finish
+  # *   #level
+  # *   lineno (Zlib::GzipReader#lineno)
+  # *   lineno= (Zlib::GzipReader#lineno=)
+  # *   #mtime
+  # *   mtime= (Zlib::GzipWriter#mtime=)
+  # *   #orig_name
+  # *   orig_name (Zlib::GzipWriter#orig_name=)
+  # *   #os_code
+  # *   path (when the underlying IO supports #path)
+  # *   #sync
+  # *   #sync=
+  # *   #to_io
+  #
+  #
+  # (due to internal structure, documentation may appear under Zlib::GzipReader or
+  # Zlib::GzipWriter)
+  #
+  class GzipFile
+    # <!-- rdoc-file=ext/zlib/zlib.c -->
+    # Raised when gzip file footer is not found.
+    #
+    class NoFooter < Zlib::GzipFile::Error
+    end
+  end
+end

data/stdlib/zlib/0/gzip_file.rbs

@@ -0,0 +1,228 @@
+# <!-- 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::GzipFile is an abstract class for handling a gzip formatted compressed
+  # file. The operations are defined in the subclasses, Zlib::GzipReader for
+  # reading, and Zlib::GzipWriter for writing.
+  #
+  # GzipReader should be used by associating an IO, or IO-like, object.
+  #
+  # ## Method Catalogue
+  #
+  # *   ::wrap
+  # *   ::open (Zlib::GzipReader::open and Zlib::GzipWriter::open)
+  # *   #close
+  # *   #closed?
+  # *   #comment
+  # *   comment= (Zlib::GzipWriter#comment=)
+  # *   #crc
+  # *   eof? (Zlib::GzipReader#eof?)
+  # *   #finish
+  # *   #level
+  # *   lineno (Zlib::GzipReader#lineno)
+  # *   lineno= (Zlib::GzipReader#lineno=)
+  # *   #mtime
+  # *   mtime= (Zlib::GzipWriter#mtime=)
+  # *   #orig_name
+  # *   orig_name (Zlib::GzipWriter#orig_name=)
+  # *   #os_code
+  # *   path (when the underlying IO supports #path)
+  # *   #sync
+  # *   #sync=
+  # *   #to_io
+  #
+  #
+  # (due to internal structure, documentation may appear under Zlib::GzipReader or
+  # Zlib::GzipWriter)
+  #
+  class GzipFile
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - Zlib::GzipReader.wrap(io, ...) { |gz| ... }
+    #   - Zlib::GzipWriter.wrap(io, ...) { |gz| ... }
+    # -->
+    # Creates a GzipReader or GzipWriter associated with `io`, passing in any
+    # necessary extra options, and executes the block with the newly created object
+    # just like File.open.
+    #
+    # The GzipFile object will be closed automatically after executing the block. If
+    # you want to keep the associated IO object open, you may call
+    # Zlib::GzipFile#finish method in the block.
+    #
+    def self.wrap: (IO io, *untyped) { (instance gz) -> void } -> void
+
+    public
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - close()
+    # -->
+    # Closes the GzipFile object. This method calls close method of the associated
+    # IO object. Returns the associated IO object.
+    #
+    def close: () -> void
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - closed?()
+    # -->
+    # Same as IO#closed?
+    #
+    def closed?: () -> void
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - comment()
+    # -->
+    # Returns comments recorded in the gzip file header, or nil if the comments is
+    # not present.
+    #
+    def comment: () -> String?
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - crc()
+    # -->
+    # Returns CRC value of the uncompressed data.
+    #
+    def crc: () -> Integer
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - finish()
+    # -->
+    # Closes the GzipFile object. Unlike Zlib::GzipFile#close, this method never
+    # calls the close method of the associated IO object. Returns the associated IO
+    # object.
+    #
+    def finish: () -> IO
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - level()
+    # -->
+    # Returns compression level.
+    #
+    def level: () -> Integer
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - mtime()
+    # -->
+    # Returns last modification time recorded in the gzip file header.
+    #
+    def mtime: () -> Time
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - orig_name()
+    # -->
+    # Returns original filename recorded in the gzip file header, or `nil` if
+    # original filename is not present.
+    #
+    def orig_name: () -> String?
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - os_code()
+    # -->
+    # Returns OS code number recorded in the gzip file header.
+    #
+    def os_code: () -> Integer
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - sync()
+    # -->
+    # Same as IO#sync
+    #
+    def sync: () -> bool
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - sync = flag
+    # -->
+    # Same as IO.  If flag is `true`, the associated IO object must respond to the
+    # `flush` method.  While `sync` mode is `true`, the compression ratio decreases
+    # sharply.
+    #
+    def sync=: (boolish) -> untyped
+
+    # <!--
+    #   rdoc-file=ext/zlib/zlib.c
+    #   - to_io()
+    # -->
+    # Same as IO.
+    #
+    def to_io: () -> IO
+  end
+end