Class ProgressStream

Namespace

NanoByte.Common.Streams

Assembly

NanoByte.Common.dll

Decorator that adds progress-tracking and cancellation to another Stream.

public sealed class ProgressStream : DelegatingStream

Inheritance

object

MarshalByRefObject

Stream

DelegatingStream

ProgressStream

Inherited Members

DelegatingStream.CanRead

DelegatingStream.CanSeek

DelegatingStream.CanWrite

DelegatingStream.CanTimeout

DelegatingStream.ReadTimeout

DelegatingStream.WriteTimeout

DelegatingStream.Position

DelegatingStream.Flush()

DelegatingStream.Seek(long, SeekOrigin)

DelegatingStream.FlushAsync(CancellationToken)

Extension Methods

BinaryStorage.SaveBinary<T>(T, Stream)

BinaryStorage.SaveBinary<T>(T, string)

JsonStorage.SaveJson<T>(T, Stream)

JsonStorage.SaveJson<T>(T, string)

JsonStorage.ToJsonString<T>(T)

XmlStorage.SaveXml<T>(T, string, string?)

UpdateUtils.To<TIn, TOut>(TIn, Func<TIn, TOut>)

ConversionUtils.ConvertToString<TType>(TType)

StreamUtils.AsArray(Stream)

StreamUtils.CopyToEx(Stream, Stream)

StreamUtils.CopyToFile(Stream, string)

StreamUtils.Read(Stream, ArraySegment<byte>)

StreamUtils.Read(Stream, int)

StreamUtils.ReadAll(Stream)

StreamUtils.ReadToString(Stream, Encoding?)

StreamUtils.Skip(Stream, int)

StreamUtils.ToMemory(Stream)

StreamUtils.TryRead(Stream, int)

StreamUtils.WithLength(Stream, long)

StreamUtils.WithSeekBuffer(Stream, int)

StreamUtils.Write(Stream, ArraySegment<byte>)

StreamUtils.Write(Stream, params byte[])

JsonStorage.ReparseAsJson<T>(object)

JsonStorage.ReparseAsJson<T>(object, T)

XmlStorage.SaveXml(object, Stream, string?)

XmlStorage.ToXmlString(object, string?)

Constructors

ProgressStream(Stream, IProgress<long>?, CancellationToken)

Decorator that adds progress-tracking and cancellation to another Stream.

public ProgressStream(Stream underlyingStream, IProgress<long>? progress = null, CancellationToken cancellationToken = default)

Parameters

underlyingStream Stream

Underlying stream to delegate to. Will be disposed together with this stream.

progress IProgress<long>

Used to report back the number of bytes that have been read or written.

cancellationToken CancellationToken

Used to signal when the user wants to cancel the stream. If signaled read an write requests will start throwing OperationCanceledException.

Properties

Length

The length of the underlying stream if CanSeek is true. Otherwise, the number of bytes read or written so far. This value can also be overriden by SetLength(long).

public override long Length { get; }

Property Value

long

Methods

Read(byte[], int, int)

When overridden in a derived class, 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)

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 int

The zero-based byte offset in buffer at which to begin storing the data read from the current stream.

count int

The maximum number of bytes to be read from the current stream.

Returns

int

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

ArgumentException

The sum of offset and count is larger than the buffer length.

ArgumentNullException

buffer is null.

ArgumentOutOfRangeException

offset or count is negative.

IOException

An I/O error occurs.

NotSupportedException

The stream does not support reading.

ObjectDisposedException

Methods were called after the stream was closed.

ReadAsync(byte[], int, int, CancellationToken)

Asynchronously 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.

public override Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken ct)

Parameters

buffer byte[]

The buffer to write the data into.

offset int

The byte offset in buffer at which to begin writing data from the stream.

count int

The maximum number of bytes to read.

ct CancellationToken

Returns

Task<int>

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

Exceptions

ArgumentNullException

buffer is null.

ArgumentOutOfRangeException

offset or count is negative.

ArgumentException

The sum of offset and count is larger than the buffer length.

NotSupportedException

The stream does not support reading.

ObjectDisposedException

The stream has been disposed.

InvalidOperationException

The stream is currently in use by a previous read operation.

SetLength(long)

Overrides the value returned by Length. Does not affect the underlying stream.

public override void SetLength(long value)

Parameters

value long

Write(byte[], int, int)

When overridden in a derived class, 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)

Parameters

buffer byte[]

An array of bytes. This method copies count bytes from buffer to the current stream.

offset int

The zero-based byte offset in buffer at which to begin copying bytes to the current stream.

count int

The number of bytes to be written to the current stream.

Exceptions

ArgumentException

The sum of offset and count is greater than the buffer length.

ArgumentNullException

buffer is null.

ArgumentOutOfRangeException

offset or count is negative.

IOException

An I/O error occured, such as the specified file cannot be found.

NotSupportedException

The stream does not support writing.

ObjectDisposedException

Write(byte[], int, int) was called after the stream was closed.

WriteAsync(byte[], int, int, CancellationToken)

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

public override Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken ct)

Parameters

buffer byte[]

The buffer to write data from.

offset int

The zero-based byte offset in buffer from which to begin copying bytes to the stream.

count int

The maximum number of bytes to write.

ct CancellationToken

Returns

Task

A task that represents the asynchronous write operation.

Exceptions

ArgumentNullException

buffer is null.

ArgumentOutOfRangeException

offset or count is negative.

ArgumentException

The sum of offset and count is larger than the buffer length.

NotSupportedException

The stream does not support writing.

ObjectDisposedException

The stream has been disposed.

InvalidOperationException

The stream is currently in use by a previous write operation.