Class FastMemoryStream
- Namespace
- Vintagestory.API.Datastructures
- Assembly
- VintagestoryAPI.dll
public class FastMemoryStream : Stream, IAsyncDisposable, IDisposable- Inheritance
-
FastMemoryStream
- Implements
- Inherited Members
- Extension Methods
Constructors
FastMemoryStream()
public FastMemoryStream()FastMemoryStream(byte[], int)
public FastMemoryStream(byte[] buffer, int length)Parameters
FastMemoryStream(int)
public FastMemoryStream(int capacity)Parameters
capacityint
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
Length
When deserializing from a buffer, this is the full buffer length
public override long Length { get; }Property Value
Position
When serializing to a buffer, indicates the count of bytes written so far
public override long Position { get; set; }Property Value
Methods
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.
GetBuffer()
public byte[] GetBuffer()Returns
- byte[]
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[] destBuffer, int offset, int count)Parameters
destBufferbyte[]offsetintThe zero-based byte offset in
bufferat which to begin storing the data read from the current stream.countintThe 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
countis 0 or the end of the stream has been reached.
Exceptions
- ArgumentException
The sum of
offsetandcountis larger than the buffer length.- ArgumentNullException
bufferis null.- ArgumentOutOfRangeException
offsetorcountis 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.
public override int ReadByte()Returns
Exceptions
- NotSupportedException
The stream does not support reading.
- ObjectDisposedException
Methods were called after the stream was closed.
RemoveFromStart(int)
public void RemoveFromStart(int newStart)Parameters
newStartint
Reset()
public void Reset()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
offsetlongA byte offset relative to the
originparameter.originSeekOriginA 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.
SetLength(long)
When overridden in a derived class, sets the length of the current stream.
public override void SetLength(long value)Parameters
valuelongThe 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.
ToArray()
public byte[] ToArray()Returns
- byte[]
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[] srcBuffer, int srcOffset, int count)Parameters
Exceptions
- ArgumentException
The sum of
offsetandcountis greater than the buffer length.- ArgumentNullException
bufferis null.- ArgumentOutOfRangeException
offsetorcountis 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.
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> inputBuffer)Parameters
inputBufferReadOnlySpan<byte>
Write(float)
public void Write(float v)Parameters
vfloat
Write(FastMemoryStream)
public void Write(FastMemoryStream src)Parameters
srcFastMemoryStream
WriteAt(int, int, int)
Used for Protobuf serialization if we need to go back and re-write a varInt value, for example the count of entities written
public void WriteAt(int pos, int v, int size)Parameters
Exceptions
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 p)Parameters
pbyte
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.
WriteInt32(int)
public void WriteInt32(int v)Parameters
vint
WriteThreeBytes(int)
public void WriteThreeBytes(int v)Parameters
vint
WriteTwoBytes(int)
public void WriteTwoBytes(int v)Parameters
vint
WriteUTF8String(string, int)
public void WriteUTF8String(string s, int lengthInBytes)