BufferedReadStream Class

Definition

Namespace:

Microsoft.AspNetCore.WebUtilities

Assembly:

Microsoft.AspNetCore.WebUtilities.dll

Package:

Microsoft.AspNetCore.App.Ref v9.0.0

A Stream that wraps another stream and allows reading lines. The data is buffered in memory.

public ref class BufferedReadStream : System::IO::Stream

public class BufferedReadStream : System.IO.Stream

type BufferedReadStream = class
    inherit Stream

Public Class BufferedReadStream
Inherits Stream

Inheritance

Stream

BufferedReadStream

Constructors

BufferedReadStream(Stream, Int32, ArrayPool<Byte>)	Creates a new stream.
BufferedReadStream(Stream, Int32)	Creates a new stream.

Properties

BufferedData	The currently buffered data.
CanRead	When overridden in a derived class, gets a value indicating whether the current stream supports reading.
CanSeek	When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
CanTimeout	Gets a value that determines whether the current stream can time out.
CanWrite	When overridden in a derived class, gets a value indicating whether the current stream supports writing.
Length	When overridden in a derived class, gets the length in bytes of the stream.
Position	When overridden in a derived class, gets or sets the position within the current stream.

Methods

Dispose(Boolean)	Releases the unmanaged resources used by the Stream and optionally releases the managed resources.
EnsureBuffered()	Ensures that the buffer is not empty.
EnsureBuffered(Int32)	Ensures that a minimum amount of buffered data is available.
EnsureBufferedAsync(CancellationToken)	Ensures that the buffer is not empty.
EnsureBufferedAsync(Int32, CancellationToken)	Ensures that a minimum amount of buffered data is available.
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.
FlushAsync(CancellationToken)	Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.
Read(Byte[], Int32, Int32)	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.
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.
ReadAsync(Memory<Byte>, 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.
ReadLine(Int32)	Reads a line. A line is defined as a sequence of characters followed by a carriage return immediately followed by a line feed. The resulting string does not contain the terminating carriage return and line feed.
ReadLineAsync(Int32, CancellationToken)	Reads a line. A line is defined as a sequence of characters followed by a carriage return immediately followed by a line feed. The resulting string does not contain the terminating carriage return and line feed.
Seek(Int64, SeekOrigin)	When overridden in a derived class, sets the position within the current stream.
SetLength(Int64)	When overridden in a derived class, sets the length of the current stream.
Write(Byte[], Int32, Int32)	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.
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.
WriteAsync(ReadOnlyMemory<Byte>, 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.