Keyoti RapidSpell WPF API Docs
ZlibStream Class
APIKeyoti.RapidSpell.Compression.WpfZlibStream
Keyoti RapidSpell WPF
Represents a Zlib stream for compression or decompression.
Declaration Syntax
C#C#Visual BasicVisual BasicVisual C++Visual C++F#F#
public class ZlibStream : Stream
public class ZlibStream : Stream
Public Class ZlibStream
	Inherits Stream
Public Class ZlibStream
	Inherits Stream
public ref class ZlibStream : public Stream
public ref class ZlibStream : public Stream
type ZlibStream =  
    class
        inherit Stream
    end
type ZlibStream =  
    class
        inherit Stream
    end
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
ZlibStream(Stream, CompressionMode)
Create a ZlibStream using the specified CompressionMode.

ZlibStream(Stream, CompressionMode, CompressionLevel)
Create a ZlibStream using the specified CompressionMode and the specified CompressionLevel.

ZlibStream(Stream, CompressionMode, Boolean)
Create a ZlibStream using the specified CompressionMode, and explicitly specify whether the captive stream should be left open after Deflation or Inflation.

ZlibStream(Stream, CompressionMode, CompressionLevel, Boolean)
Create a ZlibStream using the specified CompressionMode and the specified CompressionLevel, and explicitly specify whether the stream should be left open after Deflation or Inflation.

BeginRead(array<Byte>[]()[][], Int32, Int32, AsyncCallback, Object) HostProtectionAttribute. (Inherited from Stream.)
BeginWrite(array<Byte>[]()[][], Int32, Int32, AsyncCallback, Object) HostProtectionAttribute. (Inherited from Stream.)
BufferSize
The size of the working buffer for the compression codec.

CanRead
Indicates whether the stream can be read.
(Overrides Stream.CanRead.)
CanSeek
Indicates whether the stream supports Seek operations.
(Overrides Stream.CanSeek.)
CanTimeout (Inherited from Stream.)
CanWrite
Indicates whether the stream can be written.
(Overrides Stream.CanWrite.)
Close()()()() (Inherited from Stream.)
CompressBuffer(array<Byte>[]()[][])
Compress a byte array into a new byte array using ZLIB.

CompressString(String)
Compress a string into a byte array using ZLIB.

CreateObjRef(Type) (Inherited from MarshalByRefObject.)
CreateWaitHandle()()()() Obsolete. (Inherited from Stream.)
Dispose(Boolean)
Dispose the stream.

Dispose()()()() (Inherited from Stream.)
EndRead(IAsyncResult) (Inherited from Stream.)
EndWrite(IAsyncResult) (Inherited from Stream.)
Equals(Object) (Inherited from Object.)
Finalize()()()() (Inherited from Object.)
Flush()()()()
Flush the stream.
(Overrides Stream.Flush()()()().)
FlushMode
This property sets the flush behavior on the stream. Sorry, though, not sure exactly how to describe all the various settings.

GetHashCode()()()() (Inherited from Object.)
GetLifetimeService()()()() (Inherited from MarshalByRefObject.)
GetType()()()() (Inherited from Object.)
InitializeLifetimeService()()()() (Inherited from MarshalByRefObject.)
Length
Reading this property always throws a NotImplementedException.
(Overrides Stream.Length.)
MemberwiseClone(Boolean) (Inherited from MarshalByRefObject.)
MemberwiseClone()()()() (Inherited from Object.)
Position
The position of the stream pointer.
(Overrides Stream.Position.)
Read(array<Byte>[]()[][], Int32, Int32)
Read data from the stream.
(Overrides Stream.Read(array<Byte>[]()[][], Int32, Int32).)
ReadByte()()()() (Inherited from Stream.)
ReadTimeout (Inherited from Stream.)
Seek(Int64, SeekOrigin)
Calling this method always throws a NotImplementedException.
(Overrides Stream.Seek(Int64, SeekOrigin).)
SetLength(Int64)
Calling this method always throws a NotImplementedException.
(Overrides Stream.SetLength(Int64).)
ToString()()()() (Inherited from Object.)
TotalIn
Returns the total number of bytes input so far.

TotalOut
Returns the total number of bytes output so far.

UncompressBuffer(array<Byte>[]()[][])
Uncompress a ZLIB-compressed byte array into a byte array.

UncompressString(array<Byte>[]()[][])
Uncompress a ZLIB-compressed byte array into a single string.

Write(array<Byte>[]()[][], Int32, Int32)
Write data to the stream.
(Overrides Stream.Write(array<Byte>[]()[][], Int32, Int32).)
WriteByte(Byte) (Inherited from Stream.)
WriteTimeout (Inherited from Stream.)
Remarks

The ZlibStream is a Decorator on a Stream. It adds ZLIB compression or decompression to any stream.

Using this stream, applications can compress or decompress data via stream Read() and Write() operations. Either compresssion or decompression can occur through either reading or writing. The compression format used is ZLIB, which is documented in IETF RFC 1950, "ZLIB Compressed Data Format Specification version 3.3". This implementation of ZLIB always uses DEFLATE as the compression method. (see IETF RFC 1951, "DEFLATE Compressed Data Format Specification version 1.3.")

The ZLIB format allows for varying compression methods, window sizes, and dictionaries. This implementation always uses the DEFLATE compression method, a preset dictionary, and 15 window bits by default.

This class is similar to DeflateStream, except that it adds the RFC1950 header and trailer bytes to a compressed stream when compressing, or expects the RFC1950 header and trailer bytes when decompressing. It is also similar to the GZipStream.

Inheritance Hierarchy
See Also

Assembly: Keyoti4.RapidSpell.WPF (Module: Keyoti4.RapidSpell.WPF.dll) Version: 3.1.16.1214