ClassCompressedStream
Stream wrapper that compresses or decompresses data on the fly over a base stream, optionally applying checksum and encryption.
Definition
Namespace:Telerik.Windows.Zip
Assembly:Telerik.Windows.Zip.dll
Syntax:
public class CompressedStream : OperationStream, IDisposable, IAsyncDisposableInheritance: objectMarshalByRefObjectStreamOperationStreamCompressedStream
Implements:
Inherited Members
Constructors
CompressedStream(Stream, StreamOperationMode, CompressionSettings)
Creates a compression or decompression stream using the specified settings.
Declaration
public CompressedStream(Stream baseStream, StreamOperationMode mode, CompressionSettings settings)Parameters
baseStream
The base input/output stream.
mode
Stream operational mode.
settings
Compression settings.
Exceptions
Specified mode is not allowed for the given stream.
CompressedStream(Stream, StreamOperationMode, CompressionSettings, bool, EncryptionSettingsBase)
Creates a compression or decompression stream with explicit checksum and encryption options.
Declaration
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Crc")]
public CompressedStream(Stream baseStream, StreamOperationMode mode, CompressionSettings settings, bool useCrc32, EncryptionSettingsBase encryptionSettings)Parameters
baseStream
The base input/output stream.
mode
Stream operational mode.
settings
Compression settings.
useCrc32
Indicates whether the CRC32 (true) or Adler32 (false) checksum algorithm will be used.
encryptionSettings
Encryption settings.
Exceptions
Specified mode is not allowed for the given stream.
Properties
Checksum
Gets the running checksum (CRC32 or Adler32) accumulated from the first read/write until Flush.
CompressedSize
Gets the total compressed byte count including any encryption header bytes.
Methods
Dispose(bool)
Releases the unmanaged resources used by the Stream and optionally releases the managed resources.
Declaration
[SuppressMessage("Microsoft.Usage", "CA2215:Dispose methods should call base class dispose")]
protected override void Dispose(bool disposing)Parameters
disposing
Value which indicates whether both managed and unmanaged resources (true) on only unmanaged resources (false) should be released.
Overrides
Read(byte[], int, int)
Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
Declaration
public override int Read(byte[] buffer, int offset, int count)Parameters
buffer
byte[]
An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
offset
The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
count
The maximum number of bytes to be read from the current stream.
Returns
The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
Exceptions
The StreamOperationMode associated with
current OperationStream object does not match the underlying stream.
For example, this exception is thrown when using Read with an underlying stream that is write only.
The offset parameter is less than zero.-or- The count parameter is less than zero.
The sum of the count and offset parameters is larger than the length of the buffer.
Overrides
ReadAsync(byte[], int, int, CancellationToken)
Reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.
Declaration
public override Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)Parameters
buffer
byte[]
An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
offset
The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
count
The maximum number of bytes to be read from the current stream.
cancellationToken
The token to monitor for cancellation requests.
Returns
A task returning the total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
Overrides
SetLength(long)
Sets the length of the current stream.
Declaration
public override void SetLength(long value)Parameters
value
The desired length of the current stream in bytes.
Overrides
Write(byte[], int, int)
Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
Declaration
public override void Write(byte[] buffer, int offset, int count)Parameters
buffer
byte[]
An array of bytes. This method copies count bytes from buffer to the current stream.
offset
The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
count
The number of bytes to be written to the current stream.
Overrides
Events
ChecksumReady
Raised when checksum calculation completes for the processed data segment.