Alphabetic list: * ZLib.DeflateStream:: * ZLib.DeflateWriteStream:: * ZLib.GZipDeflateStream:: * ZLib.GZipDeflateWriteStream:: * ZLib.GZipInflateStream:: * ZLib.InflateStream:: * ZLib.RawDeflateStream:: * ZLib.RawDeflateWriteStream:: * ZLib.RawInflateStream:: * ZLib.ZlibError:: * ZLib.ZlibReadStream:: * ZLib.ZlibStream:: * ZLib.ZlibWriteStream::

Class tree:
  (Object) (Iterable) (Stream) * ZLib.ZlibStream:: * ZLib.ZlibReadStream:: * ZLib.RawDeflateStream:: * ZLib.DeflateStream:: * ZLib.GZipDeflateStream:: * ZLib.RawInflateStream:: * ZLib.GZipInflateStream:: * ZLib.InflateStream:: * ZLib.ZlibWriteStream:: * ZLib.RawDeflateWriteStream:: * ZLib.DeflateWriteStream:: * ZLib.GZipDeflateWriteStream:: (Signal) (Exception) (Error) * ZLib.ZlibError::

ZLib.DeflateStream
==================

Defined in namespace ZLib
Superclass: ZLib.RawDeflateStream
Category: Examples-Useful
     Instances of this class produce "standard" (zlib, RFC1950) deflated data.

ZLib.DeflateStream class: instance creation
-------------------------------------------

compressingTo: aStream
     Answer a stream that receives data via #nextPut: and compresses it onto aStream.

compressingTo: aStream level: level
     Answer a stream that receives data via #nextPut: and compresses it onto aStream with the given compression level.

ZLib.DeflateWriteStream
=======================

Defined in namespace ZLib
Superclass: ZLib.RawDeflateWriteStream
Category: Examples-Useful
     Instances of this class produce "standard" (zlib, RFC1950) deflated data.

ZLib.GZipDeflateStream
======================

Defined in namespace ZLib
Superclass: ZLib.RawDeflateStream
Category: Examples-Useful
     Instances of this class produce GZip (RFC1952) deflated data.

ZLib.GZipDeflateStream class: instance creation
-----------------------------------------------

compressingTo: aStream
     Answer a stream that receives data via #nextPut: and compresses it onto aStream.

compressingTo: aStream level: level
     Answer a stream that receives data via #nextPut: and compresses it onto aStream with the given compression level.

ZLib.GZipDeflateWriteStream
===========================

Defined in namespace ZLib
Superclass: ZLib.RawDeflateWriteStream
Category: Examples-Useful
     Instances of this class produce GZip (RFC1952) deflated data.

ZLib.GZipInflateStream
======================

Defined in namespace ZLib
Superclass: ZLib.RawInflateStream
Category: Examples-Useful
     Instances of this class reinflate GZip (RFC1952) deflated data.

ZLib.InflateStream
==================

Defined in namespace ZLib
Superclass: ZLib.RawInflateStream
Category: Examples-Useful
     Instances of this class reinflate "standard" (zlib, RFC1950) deflated data.

ZLib.RawDeflateStream
=====================

Defined in namespace ZLib
Superclass: ZLib.ZlibReadStream
Category: Examples-Useful
     Instances of this class produce "raw" (PKZIP) deflated data.

ZLib.RawDeflateStream class: instance creation
----------------------------------------------

compressingTo: aStream
     Answer a stream that receives data via #nextPut: and compresses it onto aStream.

compressingTo: aStream level: level
     Answer a stream that receives data via #nextPut: and compresses it onto aStream with the given compression level.

on: aStream
     Answer a stream that compresses the data in aStream with the default compression level.

on: aStream level: compressionLevel
     Answer a stream that compresses the data in aStream with the given compression level.

ZLib.RawDeflateWriteStream
==========================

Defined in namespace ZLib
Superclass: ZLib.ZlibWriteStream
Category: Examples-Useful
     Instances of this class produce "raw" (PKZIP) deflated data.

ZLib.RawDeflateWriteStream class: instance creation
---------------------------------------------------

on: aWriteStream
     Answer a stream that compresses the data in aStream with the default compression level.

on: aWriteStream level: compressionLevel
     Answer a stream that compresses the data in aStream with the given compression level.

ZLib.RawInflateStream
=====================

Defined in namespace ZLib
Superclass: ZLib.ZlibReadStream
Category: Examples-Useful
     Instances of this class reinflate "raw" (PKZIP) deflated data.

ZLib.RawInflateStream: positioning
----------------------------------

copyFrom: start to: end
     Answer the data on which the receiver is streaming, from the start-th item to the end-th.  Note that this method is 0-based, unlike the one in Collection, because a Stream's #position method returns 0-based values.  Notice that this class can only provide the illusion of random access, by appropriately rewinding the input stream or skipping compressed data.

isPositionable
     Answer true if the stream supports moving backwards with #skip:.

position: anInteger
     Set the current position in the stream to anInteger.  Notice that this class can only provide the illusion of random access, by appropriately rewinding the input stream or skipping compressed data.

reset
     Reset the stream to the beginning of the compressed data.

skip: anInteger
     Move the current position by anInteger places, either forwards or backwards.

ZLib.ZlibError
==============

Defined in namespace ZLib
Superclass: Error
Category: Examples-Useful
     This exception is raised whenever there is an error in a compressed stream.

ZLib.ZlibError: accessing
-------------------------

stream
     Answer the ZlibStream that caused the error.

stream: anObject
     Set the ZlibStream that caused the error.

ZLib.ZlibReadStream
===================

Defined in namespace ZLib
Superclass: ZLib.ZlibStream
Category: Examples-Useful
     This abstract class implements the basic buffering that is used for communication with zlib.

ZLib.ZlibReadStream: accessing-reading
--------------------------------------

nextAvailable: anInteger into: aCollection startingAt: pos
     Place up to anInteger objects from the receiver into aCollection, starting from position pos and stopping if no more data is available.

nextAvailable: anInteger putAllOn: aStream
     Copy up to anInteger objects from the receiver to aStream, stopping if no more data is available.

ZLib.ZlibReadStream: streaming
------------------------------

atEnd
     Answer whether the stream has got to an end

next
     Return the next object (character or byte) in the receiver.

peek
     Returns the next element of the stream without moving the pointer. Returns nil when at end of stream.

peekFor: anObject
     Returns true and gobbles the next element from the stream of it is equal to anObject, returns false and doesn't gobble the next element if the next element is not equal to anObject.

position
     Answer the current value of the stream pointer.  Note that only inflating streams support random access to the stream data.

ZLib.ZlibStream
===============

Defined in namespace ZLib
Superclass: Stream
Category: Examples-Useful
     This abstract class implements the basic interface to the zlib module.  Its layout matches what is expected by the C code.

ZLib.ZlibStream class: accessing
--------------------------------

bufferSize
     Answer the size of the output buffers that are passed to zlib.  Each zlib stream uses a buffer of this size.

bufferSize: anInteger
     Set the size of the output buffers that are passed to zlib.  Each zlib stream uses a buffer of this size.

defaultCompressionLevel
     Return the default compression level used by deflating streams.

defaultCompressionLevel: anInteger
     Set the default compression level used by deflating streams.  It should be a number between 1 and 9.

ZLib.ZlibStream class: instance creation
----------------------------------------

new
     This method should not be called for instances of this class.

on: aStream
     Answer an instance of the receiver that decorates aStream.

ZLib.ZlibStream: streaming
--------------------------

isExternalStream
     Answer whether the receiver streams on a file or socket.

name
     Return the name of the underlying stream.

species
     Return the type of the collections returned by #upTo: etc.

stream
     Answer the wrapped stream.

ZLib.ZlibWriteStream
====================

Defined in namespace ZLib
Superclass: ZLib.ZlibStream
Category: Examples-Useful
     This abstract class implements the basic buffering that is used for communication with zlib in a WriteStream decorator.

ZLib.ZlibWriteStream: streaming
-------------------------------

close
     Finish the deflated output to the destination stream using Z_FINISH. The destination stream is closed, which implies flushing.

contents
     Finish the deflated output to the destination stream using Z_FINISH and return the deflated data (requires the destination stream to support #contents).

finish
     Finish the deflated output to the destination stream using Z_FINISH. The destination stream is not flushed.

flush
     Flush the deflated output to the destination stream, and flush the destination stream.

flushBuffer
     Flush the deflated output to the destination stream.

flushDictionary
     Flush the deflated output to the destination stream using Z_FULL_FLUSH, and flush the destination stream.

next: n putAll: aCollection startingAt: pos
     Put n characters or bytes of aCollection, starting at the pos-th, in the deflation buffer.

nextPut: aByte
     Append a character or byte (depending on whether the destination stream works on a ByteArray or String) to the deflation buffer.

partialFlush
     Flush the deflated output to the destination stream using Z_PARTIAL_FLUSH, and flush the destination stream.

position
     Answer the number of compressed bytes written.

readStream
     Finish the deflated output to the destination stream using Z_FINISH and return a ReadStream on the deflated data (requires the destination stream to support #readStream).

syncFlush
     Flush the deflated output to the destination stream using Z_SYNC_FLUSH, and flush the destination stream.  Note that this includes the four bytes 0/0/255/255 at the end of the flush.