ClassOperationStream
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, IDisposableInheritance: objectMarshalByRefObjectStreamOperationStream
Derived Classes:
Implements:
Inherited Members
Properties
CanRead
Gets a value indicating whether the current stream supports reading.
CanSeek
Gets a value indicating whether the current stream supports seeking.
CanWrite
Gets a value indicating whether the current stream supports writing.
HasFlushedFinalBlock
Gets a value which indicates whether the final buffer block has been written/read to/from the underlying stream.
Declaration
public bool HasFlushedFinalBlock { get; }Property Value
true if the final block has been flushed or end of underlying stream is reached; otherwise, false.
Length
Gets the length in bytes of the stream.
Position
Gets or sets the position within the current stream.
Declaration
public override long Position { get; set; }Property Value
Overrides
TotalPlainCount
Gets value which specify total plain bytes count (not-compressed and not-encrypted).
TotalTransformedCount
Gets value which specify total transformed bytes count (compressed or encrypted).
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
EnsureNotDisposed()
Ensure that current stream is not disposed.
Declaration
protected void EnsureNotDisposed()Flush()
Clears all buffers for this stream and causes any buffered data to be written to the underlying device.
Declaration
public override void Flush()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
Read(byte[], int, int, CancellationToken)
Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
Declaration
protected int Read(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 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.
Seek(long, SeekOrigin)
Sets the position within the current stream.
Declaration
public override long Seek(long offset, SeekOrigin origin)Parameters
offset
A byte offset relative to the origin parameter.
origin
A value of type SeekOrigin indicating the reference point used to obtain the new position.
Returns
The new position within the current stream.
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
~OperationStream()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
Declaration
protected ~OperationStream()