Class GorgonFileSystemStream

A file stream for the Gorgon file system.

Inheritance

object

MarshalByRefObject

Stream

GorgonFileSystemStream

Implements

IDisposable

Inherited Members

Stream.Null

Stream.CopyToAsync(Stream)

Stream.CopyToAsync(Stream, int)

Stream.CopyToAsync(Stream, int, CancellationToken)

Stream.CopyTo(Stream)

Stream.CopyTo(Stream, int)

Stream.Close()

Stream.Dispose()

Stream.FlushAsync()

Stream.FlushAsync(CancellationToken)

Stream.CreateWaitHandle()

Stream.ReadAsync(byte[], int, int)

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

Stream.WriteAsync(byte[], int, int)

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

Stream.Synchronized(Stream)

Stream.ObjectInvariant()

MarshalByRefObject.MemberwiseClone(bool)

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.CreateObjRef(Type)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Gorgon.IO

Assembly: Gorgon.FileSystem.dll

Syntax

public class GorgonFileSystemStream : Stream, IDisposable

Constructors

GorgonFileSystemStream(IGorgonVirtualFile, Stream)

Initializes a new instance of the GorgonFileSystemStream class.

Declaration

protected GorgonFileSystemStream(IGorgonVirtualFile file, Stream baseStream)

Parameters

Type	Name	Description
IGorgonVirtualFile	file	File being read/written.
Stream	baseStream	The underlying stream to use for this stream.

Exceptions

Type	Condition
ArgumentNullException	Thrown when the baseStream or the file parameter is null.

Properties

CanRead

When overridden in a derived class, gets a value indicating whether the current stream supports reading.

Declaration

public override bool CanRead { get; }

Property Value

Type	Description
bool

Overrides

Stream.CanRead

CanSeek

When overridden in a derived class, gets a value indicating whether the current stream supports seeking.

Declaration

public override bool CanSeek { get; }

Property Value

Type	Description
bool

Overrides

Stream.CanSeek

CanTimeout

Gets a value that determines whether the current stream can time out.

Declaration

public override bool CanTimeout { get; }

Property Value

Type	Description
bool

Overrides

Stream.CanTimeout

CanWrite

When overridden in a derived class, gets a value indicating whether the current stream supports writing.

Declaration

public override bool CanWrite { get; }

Property Value

Type	Description
bool

Overrides

Stream.CanWrite

CloseUnderlyingStream

Property to set or return whether to close the underlying stream when this stream is closed.

Declaration

protected bool CloseUnderlyingStream { get; set; }

Property Value

Type	Description
bool

FileEntry

Property to return the file being read/written.

Declaration

protected IGorgonVirtualFile FileEntry { get; }

Property Value

Type	Description
IGorgonVirtualFile

Length

When overridden in a derived class, gets the length in bytes of the stream.

Declaration

public override long Length { get; }

Property Value

Type	Description
long

Overrides

Stream.Length

Exceptions

Type	Condition
NotSupportedException	A class derived from Stream does not support seeking.
ObjectDisposedException	Methods were called after the stream was closed.

Position

When overridden in a derived class, gets or sets the position within the current stream.

Declaration

public override long Position { get; set; }

Property Value

Type	Description
long

Overrides

Stream.Position

Exceptions

Type	Condition
IOException	An I/O error occurs.
NotSupportedException	The stream does not support seeking.
ObjectDisposedException	Methods were called after the stream was closed.

ReadTimeout

Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.

Declaration

public override int ReadTimeout { get; set; }

Property Value

Type	Description
int

Overrides

Stream.ReadTimeout

Exceptions

Type	Condition
InvalidOperationException	The ReadTimeout method always throws an InvalidOperationException.

WriteTimeout

Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.

Declaration

public override int WriteTimeout { get; set; }

Property Value

Type	Description
int

Overrides

Stream.WriteTimeout

Exceptions

Type	Condition
InvalidOperationException	The WriteTimeout method always throws an InvalidOperationException.

Methods

BeginRead(byte[], int, int, AsyncCallback, object)

Begins an asynchronous read operation.

Declaration

public override IAsyncResult BeginRead(byte[] buffer, int offset, int count, AsyncCallback callback, object state)

Parameters

Type	Name	Description
byte[]	buffer	The buffer to read the data into.
int	offset	The byte offset in buffer at which to begin writing data read from the stream.
int	count	The maximum number of bytes to read.
AsyncCallback	callback	An optional asynchronous callback, to be called when the read is complete.
object	state	A user-provided object that distinguishes this particular asynchronous read request from other requests.

Returns

Type	Description
IAsyncResult	An IAsyncResult that represents the asynchronous read, which could still be pending.

Overrides

Stream.BeginRead(byte[], int, int, AsyncCallback, object)

Exceptions

Type	Condition
IOException	Attempted an asynchronous read past the end of the stream, or a disk error occurs.
ArgumentException	One or more of the arguments is invalid.
ObjectDisposedException	Methods were called after the stream was closed.
NotSupportedException	The current Stream implementation does not support the read operation.

BeginWrite(byte[], int, int, AsyncCallback, object)

Begins an asynchronous write operation.

Declaration

public override IAsyncResult BeginWrite(byte[] buffer, int offset, int count, AsyncCallback callback, object state)

Parameters

Type	Name	Description
byte[]	buffer	The buffer to write data from.
int	offset	The byte offset in buffer from which to begin writing.
int	count	The maximum number of bytes to write.
AsyncCallback	callback	An optional asynchronous callback, to be called when the write is complete.
object	state	A user-provided object that distinguishes this particular asynchronous write request from other requests.

Returns

Type	Description
IAsyncResult	An IAsyncResult that represents the asynchronous write, which could still be pending.

Overrides

Stream.BeginWrite(byte[], int, int, AsyncCallback, object)

Exceptions

Type	Condition
IOException	Attempted an asynchronous write past the end of the stream, or a disk error occurs.
ArgumentException	One or more of the arguments is invalid.
ObjectDisposedException	Methods were called after the stream was closed.
NotSupportedException	The current Stream implementation does not support the write operation.

Dispose(bool)

Releases the unmanaged resources used by the Stream and optionally releases the managed resources.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	true to release both managed and unmanaged resources; false to release only unmanaged resources.

Overrides

Stream.Dispose(bool)

EndRead(IAsyncResult)

Waits for the pending asynchronous read to complete.

Declaration

public override int EndRead(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous request to finish.

Returns

Type	Description
int	The number of bytes read from the stream, between zero (0) and the number of bytes you requested. Streams return zero (0) only at the end of the stream, otherwise, they should block until at least one byte is available.

Overrides

Stream.EndRead(IAsyncResult)

Exceptions

Type	Condition
ArgumentNullException	asyncResult is null.
ArgumentException	asyncResult did not originate from a BeginRead(byte[], int, int, AsyncCallback, object) method on the current stream.
IOException	The stream is closed or an internal error has occurred.

EndWrite(IAsyncResult)

Ends an asynchronous write operation.

Declaration

public override void EndWrite(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	A reference to the outstanding asynchronous I/O request.

Overrides

Stream.EndWrite(IAsyncResult)

Exceptions

Type	Condition
ArgumentNullException	asyncResult is null.
ArgumentException	asyncResult did not originate from a BeginWrite(byte[], int, int, AsyncCallback, object) method on the current stream.
IOException	The stream is closed or an internal error has occurred.

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.

Declaration

public override void Flush()

Overrides

Stream.Flush()

Exceptions

Type	Condition
IOException	An I/O error occurs.

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.

Declaration

public override int Read(byte[] buffer, int offset, int count)

Parameters

Type	Name	Description
byte[]	buffer	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.
int	offset	The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
int	count	The maximum number of bytes to be read from the current stream.

Returns

Type	Description
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.

Overrides

Stream.Read(byte[], int, int)

Exceptions

Type	Condition
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.

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.

Declaration

public override int ReadByte()

Returns

Type	Description
int	The unsigned byte cast to an Int32, or -1 if at the end of the stream.

Overrides

Stream.ReadByte()

Exceptions

Type	Condition
NotSupportedException	The stream does not support reading.
ObjectDisposedException	Methods were called after the stream was closed.

Seek(long, SeekOrigin)

When overridden in a derived class, sets the position within the current stream.

Declaration

public override long Seek(long offset, SeekOrigin origin)

Parameters

Type	Name	Description
long	offset	A byte offset relative to the origin parameter.
SeekOrigin	origin	A value of type SeekOrigin indicating the reference point used to obtain the new position.

Returns

Type	Description
long	The new position within the current stream.

Overrides

Stream.Seek(long, SeekOrigin)

Exceptions

Type	Condition
IOException	An I/O error occurs.
NotSupportedException	The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
ObjectDisposedException	Methods were called after the stream was closed.

SetLength(long)

When overridden in a derived class, sets the length of the current stream.

Declaration

public override void SetLength(long value)

Parameters

Type	Name	Description
long	value	The desired length of the current stream in bytes.

Overrides

Stream.SetLength(long)

Exceptions

Type	Condition
IOException	An I/O error occurs.
NotSupportedException	The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
ObjectDisposedException	Methods were called after the stream was closed.

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.

Declaration

public override void Write(byte[] buffer, int offset, int count)

Parameters

Type	Name	Description
byte[]	buffer	An array of bytes. This method copies count bytes from buffer to the current stream.
int	offset	The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
int	count	The number of bytes to be written to the current stream.

Overrides

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

Exceptions

Type	Condition
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 occurs.
NotSupportedException	The stream does not support writing.
ObjectDisposedException	Methods were called after the stream was closed.

WriteByte(byte)

Writes a byte to the current position in the stream and advances the position within the stream by one byte.

Declaration

public override void WriteByte(byte value)

Parameters

Type	Name	Description
byte	value	The byte to write to the stream.

Overrides

Stream.WriteByte(byte)

Exceptions

Type	Condition
IOException	An I/O error occurs.
NotSupportedException	The stream does not support writing, or the stream is already closed.
ObjectDisposedException	Methods were called after the stream was closed.

Implements

IDisposable

Extension Methods

GorgonDebugExtensions.ValidateObject<T>(T, string)

GorgonIOExtensions.CopyToStream(Stream, Stream, int, byte[])

GorgonIOExtensions.CopyToStream(Stream, Stream, int, int)

GorgonIOExtensions.Read(Stream, Span<byte>)

GorgonIOExtensions.ReadString(Stream)

GorgonIOExtensions.ReadString(Stream, Encoding)

GorgonIOExtensions.Write(Stream, ReadOnlySpan<byte>)

GorgonIOExtensions.WriteString(Stream, string)

GorgonIOExtensions.WriteString(Stream, string, Encoding)

GorgonNativeExtensions.CopyTo<T>(Stream, GorgonPtr<T>, int, int?)

GorgonNativeExtensions.ToNativeBuffer<T>(Stream, int?)

GorgonNullExtensions.AsNullable<T>(object)

GorgonNullExtensions.IfNull<T>(object, T)

GorgonNullExtensions.IsNull(object)