Class VirtualFileStream
- Namespace
- Stride.Core.Serialization
- Assembly
- Stride.Core.IO.dll
A multithreaded wrapper over a Stream, used by the VirtualFileSystem. It also allows restricted access to subparts of the Stream (useful for serialization and data streaming).
public class VirtualFileStream : Stream, IAsyncDisposable, IDisposable
- Inheritance
-
VirtualFileStream
- Implements
- Inherited Members
- Extension Methods
Constructors
VirtualFileStream(Stream, long, long, bool, bool)
Initializes a new instance of the VirtualFileStream class.
public VirtualFileStream(Stream internalStream, long startPosition = 0, long endPosition = -1, bool disposeInternalStream = true, bool seekToBeginning = true)
Parameters
internalStream
StreamThe internal stream.
startPosition
longThe start position.
endPosition
longThe end position.
disposeInternalStream
boolif set to
true
this instance has ownership of the internal stream and will dispose it].seekToBeginning
bool
Exceptions
- ArgumentOutOfRangeException
startPosition and endPosition doesn't fit inside current bounds
- NotSupportedException
Attempted to create a VirtualFileStream from a Stream which doesn't support seeking.
Fields
endPosition
protected readonly long endPosition
Field Value
startPosition
protected readonly long startPosition
Field Value
virtualFileStream
protected VirtualFileStream virtualFileStream
Field Value
Properties
CanRead
When overridden in a derived class, gets a value indicating whether the current stream supports reading.
public override bool CanRead { get; }
Property Value
CanSeek
When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
public override bool CanSeek { get; }
Property Value
CanWrite
When overridden in a derived class, gets a value indicating whether the current stream supports writing.
public override bool CanWrite { get; }
Property Value
EndPosition
public long EndPosition { get; }
Property Value
InternalStream
public Stream InternalStream { get; protected set; }
Property Value
Length
When overridden in a derived class, gets the length in bytes of the stream.
public override long Length { get; }
Property Value
- long
A long value representing the length of the stream in bytes.
Exceptions
- NotSupportedException
A class derived from
Stream
does not support seeking and the length is unknown.- 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.
public override long Position { get; set; }
Property Value
- long
The current position within the stream.
Exceptions
- IOException
An I/O error occurs.
- NotSupportedException
The stream does not support seeking.
- ObjectDisposedException
Methods were called after the stream was closed.
StartPosition
public long StartPosition { get; }
Property Value
Methods
Dispose(bool)
Releases the unmanaged resources used by the Stream and optionally releases the managed resources.
protected override void Dispose(bool disposing)
Parameters
disposing
booltrue to release both managed and unmanaged resources; false to release only unmanaged resources.
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.
public override void Flush()
Exceptions
- 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.
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
intThe zero-based byte offset in
buffer
at which to begin storing the data read from the current stream.count
intThe 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
count
is 0 or the end of the stream has been reached.
Exceptions
- ArgumentException
The sum of
offset
andcount
is larger than the buffer length.- ArgumentNullException
buffer
is null.- ArgumentOutOfRangeException
offset
orcount
is negative.- IOException
An I/O error occurs.
- NotSupportedException
The stream does not support reading.
- ObjectDisposedException
Methods were called after the stream was closed.
Read(Span<byte>)
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(Span<byte> buffer)
Parameters
buffer
Span<byte>A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source.
Returns
- int
The total number of bytes read into the buffer. This can be less than the size of the buffer if that many bytes are not currently available, or zero (0) if the buffer's length is zero or the end of the stream has been reached.
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.
public override int ReadByte()
Returns
Exceptions
- 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.
public override long Seek(long offset, SeekOrigin origin)
Parameters
offset
longA byte offset relative to the
origin
parameter.origin
SeekOriginA value of type SeekOrigin indicating the reference point used to obtain the new position.
Returns
- long
The new position within the current stream.
Exceptions
- 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.
- IOException
The
offset
andorigin
would seek to a position before the start of the stream or after the end.
SetLength(long)
When overridden in a derived class, sets the length of the current stream.
public override void SetLength(long value)
Parameters
value
longThe desired length of the current stream in bytes.
Exceptions
- 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.
public override void Write(byte[] buffer, int offset, int count)
Parameters
buffer
byte[]An array of bytes. This method copies
count
bytes frombuffer
to the current stream.offset
intThe zero-based byte offset in
buffer
at which to begin copying bytes to the current stream.count
intThe number of bytes to be written to the current stream.
Exceptions
- ArgumentException
The sum of
offset
andcount
is greater than the buffer length.- ArgumentNullException
buffer
is null.- ArgumentOutOfRangeException
offset
orcount
is negative.- IOException
An I/O error occurred, such as the specified file cannot be found.
- NotSupportedException
The stream does not support writing.
- ObjectDisposedException
Write(byte[], int, int) was called after the stream was closed.
- IOException
The remaining capacity in the stream is not large enough to write the specified
buffer
.
Write(ReadOnlySpan<byte>)
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.
public override void Write(ReadOnlySpan<byte> buffer)
Parameters
buffer
ReadOnlySpan<byte>A region of memory. This method copies the contents of this region to the current stream.
Exceptions
- IOException
The remaining capacity in the stream is not large enough to write the specified
buffer
.
WriteByte(byte)
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
public override void WriteByte(byte value)
Parameters
value
byteThe byte to write to the stream.
Exceptions
- 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.
- IOException
The remaining capacity in the stream is not large enough to write the specified
buffer
.