Class ShadowingStream

Namespace

NanoByte.Common.Streams

Assembly

NanoByte.Common.dll

Decorator that copies all bytes read from a Stream to another Stream.

public sealed class ShadowingStream : DelegatingStream

Inheritance

object

MarshalByRefObject

Stream

DelegatingStream

ShadowingStream

Inherited Members

DelegatingStream.CanRead

DelegatingStream.CanSeek

DelegatingStream.CanWrite

DelegatingStream.Length

DelegatingStream.CanTimeout

DelegatingStream.ReadTimeout

DelegatingStream.WriteTimeout

DelegatingStream.Position

DelegatingStream.Flush()

DelegatingStream.Seek(long, SeekOrigin)

DelegatingStream.SetLength(long)

DelegatingStream.Write(byte[], int, int)

DelegatingStream.FlushAsync(CancellationToken)

DelegatingStream.WriteAsync(byte[], int, int, 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

ShadowingStream(Stream, Stream)

Decorator that copies all bytes read from a Stream to another Stream.

public ShadowingStream(Stream underlyingStream, Stream shadowStream)

Parameters

underlyingStream Stream

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

shadowStream Stream

The stream to copy all read bytes to.

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 cancellationToken)

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.

cancellationToken CancellationToken

The token to monitor for cancellation requests. The default value is None.

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.