.packages/system.buffers/4.0.0/lib/netstandard1.1/.xml

   1 <?xml version="1.0"?>
   2 <doc>
   3     <assembly>
   4         <name>System.Buffers</name>
   5     </assembly>
   6     <members>
   7         <member name="T:System.Buffers.ArrayPool`1">
   8             <summary>
   9             Provides a resource pool that enables reusing instances of type <see cref="T:T[]"/>.
  10             </summary>
  11             <remarks>
  12             <para>
  13             Renting and returning buffers with an <see cref="T:System.Buffers.ArrayPool`1"/> can increase performance
  14             in situations where arrays are created and destroyed frequently, resulting in significant
  15             memory pressure on the garbage collector.
  16             </para>
  17             <para>
  18             This class is thread-safe.  All members may be used by multiple threads concurrently.
  19             </para>
  20             </remarks>
  21         </member>
  22         <member name="F:System.Buffers.ArrayPool`1.s_sharedInstance">
  23             <summary>The lazily-initialized shared pool instance.</summary>
  24         </member>
  25         <member name="P:System.Buffers.ArrayPool`1.Shared">
  26             <summary>
  27             Retrieves a shared <see cref="T:System.Buffers.ArrayPool`1"/> instance.
  28             </summary>
  29             <remarks>
  30             The shared pool provides a default implementation of <see cref="T:System.Buffers.ArrayPool`1"/>
  31             that's intended for general applicability.  It maintains arrays of multiple sizes, and
  32             may hand back a larger array than was actually requested, but will never hand back a smaller
  33             array than was requested. Renting a buffer from it with <see cref="M:System.Buffers.ArrayPool`1.Rent(System.Int32)"/> will result in an
  34             existing buffer being taken from the pool if an appropriate buffer is available or in a new
  35             buffer being allocated if one is not available.
  36             </remarks>
  37         </member>
  38         <member name="M:System.Buffers.ArrayPool`1.EnsureSharedCreated">
  39             <summary>Ensures that <see cref="F:System.Buffers.ArrayPool`1.s_sharedInstance"/> has been initialized to a pool and returns it.</summary>
  40         </member>
  41         <member name="M:System.Buffers.ArrayPool`1.Create">
  42             <summary>
  43             Creates a new <see cref="T:System.Buffers.ArrayPool`1"/> instance using default configuration options.
  44             </summary>
  45             <returns>A new <see cref="T:System.Buffers.ArrayPool`1"/> instance.</returns>
  46         </member>
  47         <member name="M:System.Buffers.ArrayPool`1.Create(System.Int32,System.Int32)">
  48             <summary>
  49             Creates a new <see cref="T:System.Buffers.ArrayPool`1"/> instance using custom configuration options.
  50             </summary>
  51             <param name="maxArrayLength">The maximum length of array instances that may be stored in the pool.</param>
  52             <param name="maxArraysPerBucket">
  53             The maximum number of array instances that may be stored in each bucket in the pool.  The pool
  54             groups arrays of similar lengths into buckets for faster access.
  55             </param>
  56             <returns>A new <see cref="T:System.Buffers.ArrayPool`1"/> instance with the specified configuration options.</returns>
  57             <remarks>
  58             The created pool will group arrays into buckets, with no more than <paramref name="maxArraysPerBucket"/>
  59             in each bucket and with those arrays not exceeding <paramref name="maxArrayLength"/> in length.
  60             </remarks>
  61         </member>
  62         <member name="M:System.Buffers.ArrayPool`1.Rent(System.Int32)">
  63             <summary>
  64             Retrieves a buffer that is at least the requested length.
  65             </summary>
  66             <param name="minimumLength">The minimum length of the array needed.</param>
  67             <returns>
  68             An <see cref="T:T[]"/> that is at least <paramref name="minimumLength"/> in length.
  69             </returns>
  70             <remarks>
  71             This buffer is loaned to the caller and should be returned to the same pool via
  72             <see cref="M:System.Buffers.ArrayPool`1.Return(`0[],System.Boolean)"/> so that it may be reused in subsequent usage of <see cref="M:System.Buffers.ArrayPool`1.Rent(System.Int32)"/>.
  73             It is not a fatal error to not return a rented buffer, but failure to do so may lead to
  74             decreased application performance, as the pool may need to create a new buffer to replace
  75             the one lost.
  76             </remarks>
  77         </member>
  78         <member name="M:System.Buffers.ArrayPool`1.Return(`0[],System.Boolean)">
  79             <summary>
  80             Returns to the pool an array that was previously obtained via <see cref="M:System.Buffers.ArrayPool`1.Rent(System.Int32)"/> on the same
  81             <see cref="T:System.Buffers.ArrayPool`1"/> instance.
  82             </summary>
  83             <param name="array">
  84             The buffer previously obtained from <see cref="M:System.Buffers.ArrayPool`1.Rent(System.Int32)"/> to return to the pool.
  85             </param>
  86             <param name="clearArray">
  87             If <c>true</c> and if the pool will store the buffer to enable subsequent reuse, <see cref="M:System.Buffers.ArrayPool`1.Return(`0[],System.Boolean)"/>
  88             will clear <paramref name="array"/> of its contents so that a subsequent consumer via <see cref="M:System.Buffers.ArrayPool`1.Rent(System.Int32)"/>
  89             will not see the previous consumer's content.  If <c>false</c> or if the pool will release the buffer,
  90             the array's contents are left unchanged.
  91             </param>
  92             <remarks>
  93             Once a buffer has been returned to the pool, the caller gives up all ownership of the buffer
  94             and must not use it. The reference returned from a given call to <see cref="M:System.Buffers.ArrayPool`1.Rent(System.Int32)"/> must only be
  95             returned via <see cref="M:System.Buffers.ArrayPool`1.Return(`0[],System.Boolean)"/> once.  The default <see cref="T:System.Buffers.ArrayPool`1"/>
  96             may hold onto the returned buffer in order to rent it again, or it may release the returned buffer
  97             if it's determined that the pool already has enough buffers stored.
  98             </remarks>
  99         </member>
 100         <member name="T:System.Buffers.ArrayPoolEventSource.BufferAllocatedReason">
 101             <summary>The reason for a BufferAllocated event.</summary>
 102         </member>
 103         <member name="F:System.Buffers.ArrayPoolEventSource.BufferAllocatedReason.Pooled">
 104             <summary>The pool is allocating a buffer to be pooled in a bucket.</summary>
 105         </member>
 106         <member name="F:System.Buffers.ArrayPoolEventSource.BufferAllocatedReason.OverMaximumSize">
 107             <summary>The requested buffer size was too large to be pooled.</summary>
 108         </member>
 109         <member name="F:System.Buffers.ArrayPoolEventSource.BufferAllocatedReason.PoolExhausted">
 110             <summary>The pool has already allocated for pooling as many buffers of a particular size as it's allowed.</summary>
 111         </member>
 112         <member name="M:System.Buffers.ArrayPoolEventSource.BufferRented(System.Int32,System.Int32,System.Int32,System.Int32)">
 113             <summary>
 114             Event for when a buffer is rented.  This is invoked once for every successful call to Rent,
 115             regardless of whether a buffer is allocated or a buffer is taken from the pool.  In a
 116             perfect situation where all rented buffers are returned, we expect to see the number
 117             of BufferRented events exactly match the number of BuferReturned events, with the number
 118             of BufferAllocated events being less than or equal to those numbers (ideally significantly
 119             less than).
 120             </summary>
 121         </member>
 122         <member name="M:System.Buffers.ArrayPoolEventSource.BufferAllocated(System.Int32,System.Int32,System.Int32,System.Int32,System.Buffers.ArrayPoolEventSource.BufferAllocatedReason)">
 123             <summary>
 124             Event for when a buffer is allocated by the pool.  In an ideal situation, the number
 125             of BufferAllocated events is significantly smaller than the number of BufferRented and
 126             BufferReturned events.
 127             </summary>
 128         </member>
 129         <member name="M:System.Buffers.ArrayPoolEventSource.BufferReturned(System.Int32,System.Int32,System.Int32)">
 130             <summary>
 131             Event raised when a buffer is returned to the pool.  This event is raised regardless of whether
 132             the returned buffer is stored or dropped.  In an ideal situation, the number of BufferReturned
 133             events exactly matches the number of BufferRented events.
 134             </summary>
 135         </member>
 136         <member name="F:System.Buffers.DefaultArrayPool`1.DefaultMaxArrayLength">
 137             <summary>The default maximum length of each array in the pool (2^20).</summary>
 138         </member>
 139         <member name="F:System.Buffers.DefaultArrayPool`1.DefaultMaxNumberOfArraysPerBucket">
 140             <summary>The default maximum number of arrays per bucket that are available for rent.</summary>
 141         </member>
 142         <member name="F:System.Buffers.DefaultArrayPool`1.s_emptyArray">
 143             <summary>Lazily-allocated empty array used when arrays of length 0 are requested.</summary>
 144         </member>
 145         <member name="P:System.Buffers.DefaultArrayPool`1.Id">
 146             <summary>Gets an ID for the pool to use with events.</summary>
 147         </member>
 148         <member name="T:System.Buffers.DefaultArrayPool`1.Bucket">
 149             <summary>Provides a thread-safe bucket containing buffers that can be Rent'd and Return'd.</summary>
 150         </member>
 151         <member name="M:System.Buffers.DefaultArrayPool`1.Bucket.#ctor(System.Int32,System.Int32,System.Int32)">
 152             <summary>
 153             Creates the pool with numberOfBuffers arrays where each buffer is of bufferLength length.
 154             </summary>
 155         </member>
 156         <member name="P:System.Buffers.DefaultArrayPool`1.Bucket.Id">
 157             <summary>Gets an ID for the bucket to use with events.</summary>
 158         </member>
 159         <member name="M:System.Buffers.DefaultArrayPool`1.Bucket.Rent">
 160             <summary>Takes an array from the bucket.  If the bucket is empty, returns null.</summary>
 161         </member>
 162         <member name="M:System.Buffers.DefaultArrayPool`1.Bucket.Return(`0[])">
 163             <summary>
 164             Attempts to return the buffer to the bucket.  If successful, the buffer will be stored
 165             in the bucket and true will be returned; otherwise, the buffer won't be stored, and false
 166             will be returned.
 167             </summary>
 168         </member>
 169     </members>
 170 </doc>