summaryrefslogtreecommitdiff
path: root/.packages/microsoft.private.corefx.netcoreapp/4.7.0-preview3.19551.4/ref/netcoreapp3.1/System.Buffers.xml
blob: 8675c481069cb31577c5f25cd373d58d1c93f25d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<?xml version="1.0" encoding="utf-8"?>
<doc>
  <assembly>
    <name>System.Buffers</name>
  </assembly>
  <members>
    <member name="T:System.Buffers.ArrayPool`1">
      <summary>Provides a resource pool that enables reusing instances of type <see cref="T[]" />.</summary>
      <typeparam name="T">The type of the objects that are in the resource pool.</typeparam>
    </member>
    <member name="M:System.Buffers.ArrayPool`1.#ctor">
      <summary>Initializes a new instance of the <see cref="T:System.Buffers.ArrayPool`1" /> class.</summary>
    </member>
    <member name="M:System.Buffers.ArrayPool`1.Create">
      <summary>Creates a new instance of the <see cref="T:System.Buffers.ArrayPool`1" /> class.</summary>
      <returns>A new instance of the <see cref="T:System.Buffers.ArrayPool`1" /> class.</returns>
    </member>
    <member name="M:System.Buffers.ArrayPool`1.Create(System.Int32,System.Int32)">
      <summary>Creates a new instance of the <see cref="T:System.Buffers.ArrayPool`1" /> class using the specified configuration.</summary>
      <param name="maxArrayLength">The maximum length of an array instance that may be stored in the pool.</param>
      <param name="maxArraysPerBucket">The maximum number of array instances that may be stored in each bucket in the pool. The pool groups arrays of similar lengths into buckets for faster access.</param>
      <returns>A new instance of the <see cref="T:System.Buffers.ArrayPool`1" /> class with the specified configuration.</returns>
    </member>
    <member name="M:System.Buffers.ArrayPool`1.Rent(System.Int32)">
      <summary>Retrieves a buffer that is at least the requested length.</summary>
      <param name="minimumLength">The minimum length of the array.</param>
      <returns>An array of type <see cref="T[]" /> that is at least <paramref name="minimumLength" /> in length.</returns>
    </member>
    <member name="M:System.Buffers.ArrayPool`1.Return(`0[],System.Boolean)">
      <summary>Returns an array to the pool that was previously obtained using the <see cref="M:System.Buffers.ArrayPool`1.Rent(System.Int32)" /> method on the same <see cref="T:System.Buffers.ArrayPool`1" /> instance.</summary>
      <param name="array">A buffer to return to the pool that was previously obtained using the <see cref="M:System.Buffers.ArrayPool`1.Rent(System.Int32)" /> method.</param>
      <param name="clearArray">Indicates whether the contents of the buffer should be cleared before reuse. If <paramref name="clearArray" /> is set to <see langword="true" />, and if the pool will store the buffer to enable subsequent reuse, the <see cref="M:System.Buffers.ArrayPool`1.Return(`0[],System.Boolean)" /> method will clear the <paramref name="array" /> of its contents so that a subsequent caller using the <see cref="M:System.Buffers.ArrayPool`1.Rent(System.Int32)" /> method will not see the content of the previous caller. If <paramref name="clearArray" /> is set to <see langword="false" /> or if the pool will release the buffer, the array's contents are left unchanged.</param>
    </member>
    <member name="P:System.Buffers.ArrayPool`1.Shared">
      <summary>Gets a shared <see cref="T:System.Buffers.ArrayPool`1" /> instance.</summary>
      <returns>A shared <see cref="T:System.Buffers.ArrayPool`1" /> instance.</returns>
    </member>
  </members>
</doc>