StreamPipeReaderOptions Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| 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. |
| 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)
- Source:
- StreamPipeReaderOptions.cs
- Source:
- StreamPipeReaderOptions.cs
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.
public:
StreamPipeReaderOptions(System::Buffers::MemoryPool<System::Byte> ^ pool, int bufferSize, int minimumReadSize, bool leaveOpen);public StreamPipeReaderOptions (System.Buffers.MemoryPool<byte>? pool, int bufferSize, int minimumReadSize, bool leaveOpen);new System.IO.Pipelines.StreamPipeReaderOptions : System.Buffers.MemoryPool<byte> * int * int * bool -> System.IO.Pipelines.StreamPipeReaderOptionsPublic Sub New (pool As MemoryPool(Of Byte), bufferSize As Integer, minimumReadSize As Integer, leaveOpen As Boolean)Parameters
- pool
- MemoryPool<Byte>
The memory pool to use when allocating memory. The default value is null.
- bufferSize
- Int32
The minimum buffer size to use when renting memory from the pool. The default value is 4096.
- minimumReadSize
- Int32
The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.
- leaveOpen
- Boolean
true to leave the underlying stream open after the PipeReader completes; false to close it. The default is false.
Applies to
StreamPipeReaderOptions(MemoryPool<Byte>, Int32, Int32, Boolean, Boolean)
- Source:
- StreamPipeReaderOptions.cs
- Source:
- StreamPipeReaderOptions.cs
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.
public StreamPipeReaderOptions (System.Buffers.MemoryPool<byte>? pool = default, int bufferSize = -1, int minimumReadSize = -1, bool leaveOpen = false, bool useZeroByteReads = false);new System.IO.Pipelines.StreamPipeReaderOptions : System.Buffers.MemoryPool<byte> * int * int * bool * bool -> System.IO.Pipelines.StreamPipeReaderOptionsPublic Sub New (Optional pool As MemoryPool(Of Byte) = Nothing, Optional bufferSize As Integer = -1, Optional minimumReadSize As Integer = -1, Optional leaveOpen As Boolean = false, Optional useZeroByteReads As Boolean = false)Parameters
- pool
- MemoryPool<Byte>
The memory pool to use when allocating memory. The default value is null.
- bufferSize
- Int32
The minimum buffer size to use when renting memory from the pool. The default value is 4096.
- minimumReadSize
- Int32
The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.
- leaveOpen
- Boolean
true to leave the underlying stream open after the PipeReader completes; false to close it. The default is false.
- useZeroByteReads
- Boolean
true if reads with an empty buffer should be issued to the underlying stream before allocating memory; otherwise, false.
