Keyoti RapidSpell WPF API Docs
DeflateStream Class
APIKeyoti.RapidSpell.Compression.WpfDeflateStream
Keyoti RapidSpell WPF
A class for compressing and decompressing streams using the Deflate algorithm.
Declaration Syntax
C#C#Visual BasicVisual BasicVisual C++Visual C++F#F#
public class DeflateStream : Stream
public class DeflateStream : Stream
Public Class DeflateStream
	Inherits Stream
Public Class DeflateStream
	Inherits Stream
public ref class DeflateStream : public Stream
public ref class DeflateStream : public Stream
type DeflateStream =  
    class
        inherit Stream
    end
type DeflateStream =  
    class
        inherit Stream
    end
Members
All MembersConstructorsMethodsProperties



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

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

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

DeflateStream(Stream, CompressionMode, CompressionLevel, Boolean)
Create a DeflateStream 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 DEFLATE.

CompressString(String)
Compress a string into a byte array using DEFLATE (RFC 1951).

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.

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).)
Strategy
The ZLIB strategy to be used during compression.

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 DEFLATE'd byte array into a byte array.

UncompressString(array<Byte>[]()[][])
Uncompress a DEFLATE'd 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 DeflateStream is a Decorator on a Stream. It adds DEFLATE 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 DEFLATE, which is documented in IETF RFC 1951, "DEFLATE Compressed Data Format Specification version 1.3.".

This class is similar to ZlibStream, except that ZlibStream adds the RFC 1950 - ZLIB framing bytes to a compressed stream when compressing, or expects the RFC1950 framing bytes when decompressing. The DeflateStream does not.

Inheritance Hierarchy
See Also

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