StreamPipeWriterOptions(MemoryPool<Byte>, Int32, Boolean) Constructor

  • Reference

Definition

Namespace:
System.IO.Pipelines
Assembly:
System.IO.Pipelines.dll
Package:
System.IO.Pipelines v8.0.0
Package:
System.IO.Pipelines v9.0.0-rc.2.24473.5
Source:
StreamPipeWriterOptions.cs
Source:
StreamPipeWriterOptions.cs
Source:
StreamPipeWriterOptions.cs
Source:
StreamPipeWriterOptions.cs

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

public StreamPipeWriterOptions (System.Buffers.MemoryPool<byte>? pool = default, int minimumBufferSize = -1, bool leaveOpen = false);
new System.IO.Pipelines.StreamPipeWriterOptions : System.Buffers.MemoryPool<byte> * int * bool -> System.IO.Pipelines.StreamPipeWriterOptions
Public Sub New (Optional pool As MemoryPool(Of Byte) = Nothing, Optional minimumBufferSize As Integer = -1, Optional leaveOpen As Boolean = false)

Parameters

pool
MemoryPool<Byte>

The memory pool to use when allocating memory. The default value is null.

minimumBufferSize
Int32

The minimum buffer size to use when renting memory from the pool. The default value is 4096.

leaveOpen
Boolean

true to leave the underlying stream open after the PipeWriter completes; false to close it. The default is false.

Applies to