StreamPipeReaderOptions Class

Definition

Represents a set of options for controlling the creation of the PipeReader.

C#
public class StreamPipeReaderOptions
Inheritance
StreamPipeReaderOptions

Constructors

StreamPipeReaderOptions(MemoryPool<Byte>, Int32, Int32, Boolean, Boolean)

Initializes a StreamPipeReaderOptions instance, optionally specifying a memory pool, a minimum buffer size, a minimum read size, and whether the underlying stream should be left open after the PipeReader completes.

StreamPipeReaderOptions(MemoryPool<Byte>, Int32, Int32, Boolean)

Initializes a StreamPipeReaderOptions instance, optionally specifying a memory pool, a minimum buffer size, a minimum read size, and whether the underlying stream should be left open after the PipeReader completes.

Properties

BufferSize

Gets the minimum buffer size to use when renting memory from the Pool.

LeaveOpen

Gets the value that indicates if the underlying stream should be left open after the PipeReader completes.

MinimumReadSize

Gets the threshold of remaining bytes in the buffer before a new buffer is allocated.

Pool

Gets the MemoryPool<T> to use when allocating memory.

UseZeroByteReads

Gets the value that indicates if reads with an empty buffer should be issued to the underlying stream, in order to wait for data to arrive before allocating memory.

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

Product Versions
.NET 8 (package-provided), 9 (package-provided), 9
.NET Framework 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided)
.NET Standard 2.0 (package-provided)