CopyTo(Writer<TBufferWriter>)
public void CopyTo<TBufferWriter>(ref Writer<TBufferWriter> writer)Copies the contents of this writer to another writer.
Parameters
writerWriter<TBufferWriter>
PooledBufferStream Methods
A
System.Buffers.IBufferWriter implementation which boxes another buffer writer. Flush
override
public override void 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.
Exceptions
System.IO.IOException- An I/O error occurs.
Read(byte[], int, int)
override
public override int Read(byte[] buffer, int offset, int count)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.
Parameters
bufferbyte[]- An array of bytes. When this method returns, the buffer contains the specified byte array with the values between
offsetand (offset+count- 1) replaced by the bytes read from the current source. offsetint- The zero-based byte offset in
bufferat which to begin storing the data read from the current stream. countint- The maximum number of bytes to be read from the current stream.
Returns
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
System.ArgumentException- The sum of
offsetandcountis larger than the buffer length. System.ArgumentNullExceptionbufferisnull.System.ArgumentOutOfRangeExceptionoffsetorcountis negative.System.IO.IOException- An I/O error occurs.
System.NotSupportedException- The stream does not support reading.
System.ObjectDisposedException- Methods were called after the stream was closed.
Rent
static
public static PooledBufferStream Rent() Gets an object from the pool if one is available, otherwise creates one.
Returns
RentReadOnlySequence
public ReadOnlySequence<byte> RentReadOnlySequence() Returns a new
System.Buffers.ReadOnlySequence which must be used and returned before resetting this instance via the PooledBufferStream method. Reset
public void Reset()Return(PooledBufferStream)
static
public static void Return(PooledBufferStream stream) Return an object to the pool.
Parameters
streamPooledBufferStream
ReturnReadOnlySequence(ReadOnlySequence<byte>)
public void ReturnReadOnlySequence(in ReadOnlySequence<byte> sequence) Returns a
System.Buffers.ReadOnlySequence previously rented by PooledBufferStream; Parameters
sequenceReadOnlySequence<byte>
Seek(long, SeekOrigin)
override
public override long Seek(long offset, SeekOrigin origin)When overridden in a derived class, sets the position within the current stream.
Parameters
offsetlong- A byte offset relative to the
originparameter. originSeekOrigin- A value of type
System.IO.SeekOriginindicating the reference point used to obtain the new position.
Returns
The new position within the current stream.
Exceptions
System.IO.IOException- An I/O error occurs.
System.NotSupportedException- The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
System.ObjectDisposedException- Methods were called after the stream was closed.
SetLength(long)
override
public override void SetLength(long value)When overridden in a derived class, sets the length of the current stream.
Parameters
valuelong- The desired length of the current stream in bytes.
Exceptions
System.IO.IOException- An I/O error occurs.
System.NotSupportedException- The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
System.ObjectDisposedException- Methods were called after the stream was closed.
ToArray
public byte[] ToArray() Returns the data which has been written as an array.
Returns
The data which has been written.
Write(byte[], int, int)
override
public override void Write(byte[] buffer, int offset, int count)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.
Parameters
bufferbyte[]- An array of bytes. This method copies
countbytes frombufferto the current stream. offsetint- The zero-based byte offset in
bufferat which to begin copying bytes to the current stream. countint- The number of bytes to be written to the current stream.
Exceptions
System.ArgumentException- The sum of
offsetandcountis greater than the buffer length. System.ArgumentNullExceptionbufferisnull.System.ArgumentOutOfRangeExceptionoffsetorcountis negative.System.IO.IOException- An I/O error occurred, such as the specified file cannot be found.
System.NotSupportedException- The stream does not support writing.
System.ObjectDisposedExceptionSystem.IO.Stream.Writewas called after the stream was closed.