AutoResetStream Class

Decorates a Stream instance to support auto-rewind after read/write access.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.IOStream
      BionicCode.Utilities.Net.Standard.IOAutoResetStream

Namespace: BionicCode.Utilities.Net.Standard.IO
Assembly: BionicCode.Utilities.Net.Standard (in BionicCode.Utilities.Net.Standard.dll) Version: 1.0.2

Syntax

public class AutoResetStream : Stream

Public Class AutoResetStream
	Inherits Stream

Dim instance As AutoResetStream

public ref class AutoResetStream : public Stream

type AutoResetStream =  
    class
        inherit Stream
    end

public class AutoResetStream extends Stream

public class AutoResetStream extends Stream

BionicCode.Utilities.Net.Standard.IO.AutoResetStream = function();

Type.createClass(
	'BionicCode.Utilities.Net.Standard.IO.AutoResetStream',
	Stream);

 CLASS AutoResetStream INHERIT Stream

The AutoResetStream type exposes the following members.

Constructors

	Name	Description
	AutoResetStream	Default constructor. Creates an instance where the BaseStream is set to a MemoryStream.
	AutoResetStream(Stream)	Constructor which accepts the Stream instance to decorate in order to extend its behavior.
	AutoResetStream(Stream, Boolean)	Constructor which accepts the Stream instance to decorate in order to extend its behavior.

Top

Properties

	Name	Description
	BaseStream	The decorated Stream instance which will be extended.
	CanRead	When overridden in a derived class, gets a value indicating whether the current stream supports reading. (Overrides StreamCanRead.)
	CanSeek	When overridden in a derived class, gets a value indicating whether the current stream supports seeking. (Overrides StreamCanSeek.)
	CanTimeout	Gets a value that determines whether the current stream can time out. (Overrides StreamCanTimeout.)
	CanWrite	When overridden in a derived class, gets a value indicating whether the current stream supports writing. (Overrides StreamCanWrite.)
	IsDisposingDecoratedStream	Gets whether the decorated underlying Stream will be closed or disposed when the AutoResetStream instance is closed or disposed. Use constructor to set the value in order to configure the behavior.
	Length	When overridden in a derived class, gets the length in bytes of the stream. (Overrides StreamLength.)
	Position	When overridden in a derived class, gets or sets the position within the current stream. (Overrides StreamPosition.)
	ReadTimeout	Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Overrides StreamReadTimeout.)
	WriteTimeout	Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Overrides StreamWriteTimeout.)

Top

Methods

	Name	Description
	BeginRead	Begins an asynchronous read operation. (Consider using ReadAsync(Byte, Int32, Int32) instead.) (Inherited from Stream.)
	BeginWrite	Begins an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.) (Inherited from Stream.)
	Close	Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed. (Overrides StreamClose.)
	CopyTo(Stream)	Reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.)
	CopyTo(Stream, Int32)	Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.)
	CopyToAsync(Stream)	Asynchronously reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.)
	CopyToAsync(Stream, Int32)	Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.)
	CopyToAsync(Stream, Int32, CancellationToken)	Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. (Overrides StreamCopyToAsync(Stream, Int32, CancellationToken).)
	CreateWaitHandle	Obsolete. Allocates a WaitHandle object. (Inherited from Stream.)
	Dispose	Releases all resources used by the Stream. (Inherited from Stream.)
	Dispose(Boolean)	Releases the unmanaged resources used by the Stream and optionally releases the managed resources. (Overrides StreamDispose(Boolean).)
	EndRead	Waits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte, Int32, Int32) instead.) (Inherited from Stream.)
	EndWrite	Ends an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.) (Inherited from Stream.)
	Equals	Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Flush	When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Overrides StreamFlush.)
	FlushAsync	Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from Stream.)
	FlushAsync(CancellationToken)	Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. (Overrides StreamFlushAsync(CancellationToken).)
	GetHashCode	Serves as the default hash function. (Overrides ObjectGetHashCode.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Overrides MarshalByRefObjectInitializeLifetimeService.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	ObjectInvariant	Obsolete. Provides support for a Contract. (Inherited from Stream.)
	Read	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. (Overrides StreamRead(Byte, Int32, Int32).)
	ReadAsync(Byte, Int32, Int32)	Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Stream.)
	ReadAsync(Byte, Int32, Int32, 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. (Overrides StreamReadAsync(Byte, Int32, Int32, CancellationToken).)
	ReadByte	Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. (Overrides StreamReadByte.)
	Reset	Resets the Position to an offset of '0' relative to the provided seekOrigin.
	Seek	When overridden in a derived class, sets the position within the current stream. (Overrides StreamSeek(Int64, SeekOrigin).)
	SetLength	When overridden in a derived class, sets the length of the current stream. (Overrides StreamSetLength(Int64).)
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)
	Write	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. (Overrides StreamWrite(Byte, Int32, Int32).)
	WriteAsync(Byte, Int32, Int32)	Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Inherited from Stream.)
	WriteAsync(Byte, Int32, Int32, 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. (Overrides StreamWriteAsync(Byte, Int32, Int32, CancellationToken).)
	WriteByte	Writes a byte to the current position in the stream and advances the position within the stream by one byte. (Overrides StreamWriteByte(Byte).)

Top

Extension Methods

	Name	Description
	HasReachedEnd	Return whether the end of a Stream is reached. (Defined by HelperExtensions.)
	ToDictionary	(Defined by HelperExtensions.)

Top

Reference

BionicCode.Utilities.Net.Standard.IO Namespace