Delegates all stream access to an underlying stream. Disposing this stream will not dispose the wrapped stream unless the derived implementation does that explicitly.

Namespace

Interfaces

IDisposable
IAsyncDisposable

Base Types

object
MarshalByRefObject
Stream

Derived Types

graph BT Type-->Base0["Stream"] Base0-->Base1["MarshalByRefObject"] Base1-->Base2["object"] Type-.->Interface0["IDisposable"] Type-.->Interface1["IAsyncDisposable"] Type["DelegatingStream"] class Type type-node Derived0["TestContentStream"]-->Type click Derived0 "/api/Statiq.Testing/TestContentStream" Derived1["ActionDisposableStream"]-->Type click Derived1 "/api/Statiq.Common/ActionDisposableStream" Derived2["SignalingStream"]-->Type click Derived2 "/api/Statiq.Common/SignalingStream"

Syntax

public abstract class DelegatingStream : Stream, IDisposable, IAsyncDisposable

Constructors

Name	Summary
DelegatingStream(Stream)

Properties

Name	Property Type	Summary
CanRead	bool
CanSeek	bool
CanTimeout	bool
CanWrite	bool
Length	long
Position	long
ReadTimeout	int
Stream	Stream
WriteTimeout	int

Methods

Name	Return Value	Summary
BeginRead(byte[], int, int, AsyncCallback, object)	IAsyncResult
BeginWrite(byte[], int, int, AsyncCallback, object)	IAsyncResult
CopyTo(Stream, int)	void
CopyToAsync(Stream, int, CancellationToken)	Task
EndRead(IAsyncResult)	int
EndWrite(IAsyncResult)	void
Flush()	void
FlushAsync(CancellationToken)	Task
Read(byte[], int, int)	int
ReadAsync(byte[], int, int, CancellationToken)	Task<int>
ReadByte()	int
Seek(long, SeekOrigin)	long
SetLength(long)	void
Write(byte[], int, int)	void
WriteAsync(byte[], int, int, CancellationToken)	Task
WriteByte(byte)	void

Extension Methods

Name	Value	Summary
CopyToAsync(TextWriter, int)	Task	Copies a `Stream` to a `System.IO.TextWriter` using a buffer and leaves the stream open after copying. From StreamExtensions
GetWriter(bool)	StreamWriter	Creates a `StreamWriter` for the specified stream. The biggest difference between this and creating a `StreamWriter` directly is that the new `StreamWriter` will default to leaving the underlying stream open on disposal. Remember to flush the returned writer after all data have been written. From StreamExtensions
ReadToEnd()	string	From StreamExtensions
ThrowIfNull<DelegatingStream>(string)	T	From GuardExtensions
ToDocument<DelegatingStream>(IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<DelegatingStream>(IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<DelegatingStream>(NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<DelegatingStream>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<DelegatingStream>(NormalizedPath, NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<DelegatingStream>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions