Wraps a Stream and signals when it's disposed.

Namespace

Interfaces

IDisposable
IAsyncDisposable

Base Types

object
MarshalByRefObject
Stream
DelegatingStream

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

Syntax

public class SignalingStream : DelegatingStream, IDisposable, IAsyncDisposable

Constructors

Name	Summary
SignalingStream(Stream, EventWaitHandle)

Properties

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

Methods

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

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<SignalingStream>(string)	T	From GuardExtensions
ToDocument<SignalingStream>(IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<SignalingStream>(IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<SignalingStream>(NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<SignalingStream>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<SignalingStream>(NormalizedPath, NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<SignalingStream>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions