OperationStream
Operational stream. Base class for cryptographic and compression streams.
Definition
Namespace:Telerik.Windows.Zip
Assembly:Telerik.Windows.Zip.dll
Syntax:
public abstract class OperationStream : Stream, IDisposable, IAsyncDisposableInheritance: objectMarshalByRefObjectStreamOperationStream
Derived Classes:
Implements:
Inherited Members
Methods
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
protected ~OperationStream()Releases the unmanaged resources used by the Stream and optionally releases the managed resources.
[SuppressMessage("Microsoft.Usage", "CA2215:Dispose methods should call base class dispose")]
protected override void Dispose(bool disposing)Value which indicates whether both managed and unmanaged resources (true) on only unmanaged resources (false) should be released.
Overrides:
Ensure that current stream is not disposed.
protected void EnsureNotDisposed()Clears all buffers for this stream and causes any buffered data to be written to the underlying device.
public override void Flush()Overrides:
Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
protected int Read(byte[] buffer, int offset, int count, CancellationToken cancellationToken)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.
offsetintThe zero-based byte offset in buffer at which to begin storing the data read from the current stream.
countintThe maximum number of bytes to be read from the current stream.
cancellationTokenCancellationTokenThe cancellation token used to cancel the operation
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.
Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
public override int Read(byte[] buffer, int offset, int count)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.
offsetintThe zero-based byte offset in buffer at which to begin storing the data read from the current stream.
countintThe 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:
Sets the position within the current stream.
public override long Seek(long offset, SeekOrigin origin)A byte offset relative to the origin parameter.
originSeekOriginA value of type SeekOrigin indicating the reference point used to obtain the new position.
Returns:The new position within the current stream.
Overrides:
Sets the length of the current stream.
public override void SetLength(long value)The desired length of the current stream in bytes.
Overrides:
Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
public override void Write(byte[] buffer, int offset, int count)An array of bytes. This method copies count bytes from buffer to the current stream.
offsetintThe zero-based byte offset in buffer at which to begin copying bytes to the current stream.
countintThe number of bytes to be written to the current stream.
Overrides:
Properties
Gets a value indicating whether the current stream supports reading.
public override bool CanRead { get; }Overrides:
Gets a value indicating whether the current stream supports seeking.
public override bool CanSeek { get; }Overrides:
Gets a value indicating whether the current stream supports writing.
public override bool CanWrite { get; }Overrides:
Gets a value which indicates whether the final buffer block has been written/read to/from the underlying stream.
public bool HasFlushedFinalBlock { get; }true if the final block has been flushed or end of underlying stream is reached; otherwise, false.
Gets the length in bytes of the stream.
public override long Length { get; }Overrides:
Gets or sets the position within the current stream.
public override long Position { get; set; }Overrides:
Gets value which specify total plain bytes count (not-compressed and not-encrypted).
public long TotalPlainCount { get; }Gets value which specify total transformed bytes count (compressed or encrypted).
public long TotalTransformedCount { get; }