'Declaration Public Class CompressedStream Inherits System.IO.Stream Implements System.IDisposable
'Usage Dim instance As CompressedStream
public class CompressedStream : System.IO.Stream, System.IDisposable
Xceed .NET Libraries Documentation
'Declaration Public Class CompressedStream Inherits System.IO.Stream Implements System.IDisposable
'Usage Dim instance As CompressedStream
public class CompressedStream : System.IO.Stream, System.IDisposable
Compression is applied to data being written to the stream, and decompression is performed when data is read from the stream.
The compression engine itself is not built into the CompressedStream class. Instead, user-supplied Compressor and Decompressor classes are used.
It is possible to implement your own compression algorithm by implementing classes derived from Compressor and Decompressor.
By default, closing the CompressedStream will also close the inner stream. This behavior can be modified by setting the Transient property to true%.
System.Object
System.MarshalByRefObject
System.IO.Stream
Xceed.Compression.CompressedStream
| Name | Description | |
|---|---|---|
 | CompressedStream Constructor | Overloaded. |
| Name | Description | |
|---|---|---|
 | CanRead | Overridden. Determines whether the inner stream supports reading AND the compressed stream supports data decompression. |
| CanSeek | Overridden. A CompressedStream object is not seekable. |
| CanTimeout | (Inherited from System.IO.Stream) |
| CanWrite | Overridden. Determines whether the inner stream supports writing AND the compressed stream supports data compression. |
| CompressorCache | |
| DecompressorCache | |
| InnerStream | Gets the System.IO.Stream that was passed when creating this CompressedStream. |
| Length | Overridden. A CompressedStream object is not seekable. |
| Position | Overridden. A CompressedStream object is not seekable. |
| ReadTimeout | (Inherited from System.IO.Stream) |
| RemainingOffset | Gets the negative byte offset at which the compressed data ends inside the last data buffer read by the object. |
| Transient | Gets or sets a boolean value indicating if the stream is responsible for closing its inner stream. |
| WriteTimeout | (Inherited from System.IO.Stream) |
| Name | Description | |
|---|---|---|
 | BeginRead | (Inherited from System.IO.Stream) |
| BeginWrite | (Inherited from System.IO.Stream) |
| Close | (Inherited from System.IO.Stream) |
| CopyTo | Overloaded. (Inherited from System.IO.Stream) |
| CopyToAsync | Overloaded. (Inherited from System.IO.Stream) |
 | CreateBwtCompressor | |
| CreateBZip2Compressor | |
| CreateDeflate64Compressor | |
| CreateDeflate64Decompressor | |
| CreateDeflateCompressor | |
| CreateDeflateDecompressor | |
| CreateLzmaCompressor | |
| CreateObjRef | (Inherited from System.MarshalByRefObject) |
| CreatePPMdCompressor | |
| Dispose | Overloaded. Overridden. Provides correct cleanup of resources in the base class and its derived classes. |
| EndRead | (Inherited from System.IO.Stream) |
| EndWrite | (Inherited from System.IO.Stream) |
| Flush | Overridden. Causes all pending compressed data to be written to the inner stream, and updates the underlying data source or repository of the inner stream with the current state of the buffer. |
| FlushAsync | Overloaded. (Inherited from System.IO.Stream) |
| GetLifetimeService | (Inherited from System.MarshalByRefObject) |
| InitializeLifetimeService | (Inherited from System.MarshalByRefObject) |
| Read | Overridden. Reads and decompresses a sequence of bytes from the inner stream. |
| ReadAsync | Overloaded. (Inherited from System.IO.Stream) |
| ReadByte | (Inherited from System.IO.Stream) |
| Seek | Overridden. A CompressedStream object is not seekable. |
| SetLength | Overridden. A CompressedStream object is not seekable. |
| SetupPPMdCompression | Prepares PPMd compression using the specified Stream and compression level. |
| SetupPPMdDecompression | Prepares PPMd decompression using the specified Stream and compression level. |
| WillUseCompression | Determines whether a compression format will be used, based on a specified compression method and level. |
| Write | Overridden. Compresses and writes a sequence of bytes to the inner stream. |
| WriteAsync | Overloaded. (Inherited from System.IO.Stream) |
| WriteByte | (Inherited from System.IO.Stream) |
| Name | Description | |
|---|---|---|
 | CreateWaitHandle | (Inherited from System.IO.Stream) |
| Finalize | Allows the CompressedStream object to attempt to free resources and perform other cleanup operations before it is reclaimed by garbage collection. |
| MemberwiseClone | Overloaded. (Inherited from System.MarshalByRefObject) |
| ObjectInvariant | (Inherited from System.IO.Stream) |
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2