Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions xml/System.Buffers.Binary/BinaryPrimitives.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1270,6 +1270,11 @@ Reads exactly 8 bytes from the beginning of the span.
<paramref name="source" /> is too small to contain a <see cref="T:System.UIntPtr" />.</exception>
</Docs>
</Member>
<MemberGroup MemberName="ReverseEndianness">
<Docs>
<summary>Reverses a primitive value by performing an endianness swap of the specified <see cref="T:System.Int16" /> value.</summary>
</Docs>
</MemberGroup>
<Member MemberName="ReverseEndianness">
<MemberSignature Language="C#" Value="public static byte ReverseEndianness (byte value);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int8 ReverseEndianness(unsigned int8 value) cil managed" />
Expand Down
15 changes: 15 additions & 0 deletions xml/System.Buffers.Text/Base64.xml
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,11 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="DecodeFromUtf8">
<Docs>
<summary>Decodes the span of UTF-8 encoded text represented as base 64 into binary data. If the input is not a multiple of 4, it will decode as much as it can, to the closest multiple of 4.</summary>
</Docs>
</MemberGroup>
<Member MemberName="DecodeFromUtf8">
<MemberSignature Language="C#" Value="public static byte[] DecodeFromUtf8 (ReadOnlySpan&lt;byte&gt; source);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int8[] DecodeFromUtf8(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; source) cil managed" />
Expand Down Expand Up @@ -500,6 +505,11 @@ This method cannot return the <xref:System.Buffers.OperationStatus.DestinationTo
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="EncodeToUtf8">
<Docs>
<summary>Encodes the span of binary data into UTF-8 encoded text represented as base 64.</summary>
</Docs>
</MemberGroup>
<Member MemberName="EncodeToUtf8">
<MemberSignature Language="C#" Value="public static byte[] EncodeToUtf8 (ReadOnlySpan&lt;byte&gt; source);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int8[] EncodeToUtf8(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; source) cil managed" />
Expand Down Expand Up @@ -851,6 +861,11 @@ This method cannot return <xref:System.Buffers.OperationStatus.NeedMoreData?disp
<paramref name="length" /> is less than 0 or larger than 1610612733 (since encode inflates the data by 4/3).</exception>
</Docs>
</Member>
<MemberGroup MemberName="IsValid">
<Docs>
<summary>Validates that the specified span of text is comprised of valid base-64 encoded data.</summary>
</Docs>
</MemberGroup>
<Member MemberName="IsValid">
<MemberSignature Language="C#" Value="public static bool IsValid (ReadOnlySpan&lt;byte&gt; base64TextUtf8);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsValid(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; base64TextUtf8) cil managed" />
Expand Down
25 changes: 25 additions & 0 deletions xml/System.Buffers.Text/Base64Url.xml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@
<remarks>Base64Url encoding uses the same alphabet as standard Base64 encoding, except that the characters '+' and '/' are replaced with '-' and '_' respectively to make the output URL-safe.</remarks>
</Docs>
<Members>
<MemberGroup MemberName="DecodeFromChars">
<Docs>
<summary>Decodes the span of unicode ASCII chars represented as Base64Url into binary data.</summary>
</Docs>
</MemberGroup>
<Member MemberName="DecodeFromChars">
<MemberSignature Language="C#" Value="public static byte[] DecodeFromChars (ReadOnlySpan&lt;char&gt; source);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int8[] DecodeFromChars(valuetype System.ReadOnlySpan`1&lt;char&gt; source) cil managed" />
Expand Down Expand Up @@ -175,6 +180,11 @@
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="DecodeFromUtf8">
<Docs>
<summary>Decodes the span of UTF-8 encoded text represented as Base64Url into binary data.</summary>
</Docs>
</MemberGroup>
<Member MemberName="DecodeFromUtf8">
<MemberSignature Language="C#" Value="public static byte[] DecodeFromUtf8 (ReadOnlySpan&lt;byte&gt; source);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int8[] DecodeFromUtf8(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; source) cil managed" />
Expand Down Expand Up @@ -371,6 +381,11 @@
</exception>
</Docs>
</Member>
<MemberGroup MemberName="EncodeToChars">
<Docs>
<summary>Encodes the span of binary data into unicode ASCII chars represented as Base64Url.</summary>
</Docs>
</MemberGroup>
<Member MemberName="EncodeToChars">
<MemberSignature Language="C#" Value="public static char[] EncodeToChars (ReadOnlySpan&lt;byte&gt; source);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig char[] EncodeToChars(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; source) cil managed" />
Expand Down Expand Up @@ -537,6 +552,11 @@
<remarks>This implementation of the Base64Url encoding omits the optional padding characters. The encoding uses '-' and '_' instead of the '+' and '/' characters used in standard Base64 encoding.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="EncodeToUtf8">
<Docs>
<summary>Encodes the span of binary data into UTF-8 encoded text represented as Base64Url.</summary>
</Docs>
</MemberGroup>
<Member MemberName="EncodeToUtf8">
<MemberSignature Language="C#" Value="public static byte[] EncodeToUtf8 (ReadOnlySpan&lt;byte&gt; source);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int8[] EncodeToUtf8(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; source) cil managed" />
Expand Down Expand Up @@ -735,6 +755,11 @@
<exception cref="T:System.ArgumentOutOfRangeException">The specified <paramref name="base64Length" /> is less than 0.</exception>
</Docs>
</Member>
<MemberGroup MemberName="IsValid">
<Docs>
<summary>Validates that the specified span of text is comprised of valid base-64 encoded data.</summary>
</Docs>
</MemberGroup>
<Member MemberName="IsValid">
<MemberSignature Language="C#" Value="public static bool IsValid (ReadOnlySpan&lt;byte&gt; utf8Base64UrlText);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsValid(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; utf8Base64UrlText) cil managed" />
Expand Down
5 changes: 5 additions & 0 deletions xml/System.Buffers.Text/Utf8Formatter.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName="TryFormat">
<Docs>
<summary>Formats a <see cref="T:System.Byte" /> as a UTF8 string.</summary>
</Docs>
</MemberGroup>
<Member MemberName="TryFormat">
<MemberSignature Language="C#" Value="public static bool TryFormat (bool value, Span&lt;byte&gt; destination, out int bytesWritten, System.Buffers.StandardFormat format = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryFormat(bool value, valuetype System.Span`1&lt;unsigned int8&gt; destination, [out] int32&amp; bytesWritten, valuetype System.Buffers.StandardFormat format) cil managed" />
Expand Down
5 changes: 5 additions & 0 deletions xml/System.Buffers.Text/Utf8Parser.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName="TryParse">
<Docs>
<summary>Parses a <see cref="T:System.Byte" /> at the start of a Utf8 string.</summary>
</Docs>
</MemberGroup>
<Member MemberName="TryParse">
<MemberSignature Language="C#" Value="public static bool TryParse (ReadOnlySpan&lt;byte&gt; source, out bool value, out int bytesConsumed, char standardFormat = '\0');" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryParse(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; source, [out] bool&amp; value, [out] int32&amp; bytesConsumed, char standardFormat) cil managed" />
Expand Down
5 changes: 5 additions & 0 deletions xml/System.Buffers/ArrayBufferWriter`1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Buffers.ArrayBufferWriter`1" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ArrayBufferWriter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
Expand Down
5 changes: 5 additions & 0 deletions xml/System.Buffers/ArrayPool`1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,11 @@ Note that this constructor is protected; it can only be called by classes derive
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="Create">
<Docs>
<summary>Creates a new instance of the <see cref="T:System.Buffers.ArrayPool`1" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static System.Buffers.ArrayPool&lt;T&gt; Create ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Buffers.ArrayPool`1&lt;!T&gt; Create() cil managed" />
Expand Down
5 changes: 5 additions & 0 deletions xml/System.Buffers/MemoryManager`1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,11 @@ The `MemoryManager<T>` class is used to extend the knowledge of types that <xref
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="CreateMemory">
<Docs>
<summary>Returns a memory buffer consisting of a specified number of elements from the memory managed by the current memory manager.</summary>
</Docs>
</MemberGroup>
<Member MemberName="CreateMemory">
<MemberSignature Language="C#" Value="protected Memory&lt;T&gt; CreateMemory (int length);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance valuetype System.Memory`1&lt;!T&gt; CreateMemory(int32 length) cil managed" />
Expand Down
5 changes: 5 additions & 0 deletions xml/System.Buffers/MemoryPool`1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,11 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="Dispose">
<Docs>
<summary>Frees all resources used by the memory pool.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
Expand Down
15 changes: 15 additions & 0 deletions xml/System.Buffers/NIndex.xml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@ int lastElement = someArray[^1]; // lastElement = 5
</example>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Buffers.NIndex" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NIndex (Index index);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Index index) cil managed" />
Expand Down Expand Up @@ -114,6 +119,11 @@ int lastElement = someArray[^1]; // lastElement = 5
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="Equals">
<Docs>
<summary>Compares the current NIndex object to another object of the same type for equality.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (System.Buffers.NIndex other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(valuetype System.Buffers.NIndex other) cil managed" />
Expand Down Expand Up @@ -347,6 +357,11 @@ int lastElement = someArray[^1]; // lastElement = 5
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="op_Implicit">
<Docs>
<summary>Converts an integer number to an NIndex.</summary>
</Docs>
</MemberGroup>
<Member MemberName="op_Implicit">
<MemberSignature Language="C#" Value="public static implicit operator System.Buffers.NIndex (Index value);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname valuetype System.Buffers.NIndex op_Implicit(valuetype System.Index value) cil managed" />
Expand Down
10 changes: 10 additions & 0 deletions xml/System.Buffers/NRange.xml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Buffers.NRange" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NRange (Range range);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Range range) cil managed" />
Expand Down Expand Up @@ -153,6 +158,11 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="Equals">
<Docs>
<summary>Compares the current <see cref="T:System.Buffers.NRange" /> object to another object of the same type for equality.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (System.Buffers.NRange other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(valuetype System.Buffers.NRange other) cil managed" />
Expand Down
15 changes: 15 additions & 0 deletions xml/System.Buffers/ReadOnlySequence`1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,11 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Buffers.ReadOnlySequence`1" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ReadOnlySequence (ReadOnlyMemory&lt;T&gt; memory);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.ReadOnlyMemory`1&lt;!T&gt; memory) cil managed" />
Expand Down Expand Up @@ -457,6 +462,11 @@
<exception cref="T:System.ArgumentOutOfRangeException">The position is out of range.</exception>
</Docs>
</Member>
<MemberGroup MemberName="GetPosition">
<Docs>
<summary>Returns a new <see cref="T:System.SequencePosition" /> at an <paramref name="offset" /> from the start of the sequence.</summary>
</Docs>
</MemberGroup>
<Member MemberName="GetPosition">
<MemberSignature Language="C#" Value="public SequencePosition GetPosition (long offset);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.SequencePosition GetPosition(int64 offset) cil managed" />
Expand Down Expand Up @@ -639,6 +649,11 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="Slice">
<Docs>
<summary>Forms a slice out of the given <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at <paramref name="start" />, with <paramref name="length" /> items.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Slice">
<MemberSignature Language="C#" Value="public System.Buffers.ReadOnlySequence&lt;T&gt; Slice (long start);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Buffers.ReadOnlySequence`1&lt;!T&gt; Slice(int64 start) cil managed" />
Expand Down
5 changes: 5 additions & 0 deletions xml/System.Buffers/SearchValues.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@
<see cref="T:System.Buffers.SearchValues`1" /> instances are optimized for situations where the same set of values is frequently used for searching at run time.</remarks>
</Docs>
<Members>
<MemberGroup MemberName="Create">
<Docs>
<summary>Creates an optimized representation of <paramref name="values" /> used for efficient searching.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static System.Buffers.SearchValues&lt;byte&gt; Create (scoped ReadOnlySpan&lt;byte&gt; values);" FrameworkAlternate="net-10.0;net-11.0;net-9.0" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Buffers.SearchValues`1&lt;unsigned int8&gt; Create(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; values) cil managed" />
Expand Down
10 changes: 10 additions & 0 deletions xml/System.Buffers/SequenceReaderExtensions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName="TryReadBigEndian">
<Docs>
<summary>Tries to read an <see cref="T:System.Int16" /> as big endian.</summary>
</Docs>
</MemberGroup>
<Member MemberName="TryReadBigEndian">
<MemberSignature Language="C#" Value="public static bool TryReadBigEndian (this ref System.Buffers.SequenceReader&lt;byte&gt; reader, out short value);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryReadBigEndian(valuetype System.Buffers.SequenceReader`1&lt;unsigned int8&gt;&amp; reader, [out] int16&amp; value) cil managed" />
Expand Down Expand Up @@ -159,6 +164,11 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="TryReadLittleEndian">
<Docs>
<summary>Tries to read an <see cref="T:System.Int16" /> as little endian.</summary>
</Docs>
</MemberGroup>
<Member MemberName="TryReadLittleEndian">
<MemberSignature Language="C#" Value="public static bool TryReadLittleEndian (this ref System.Buffers.SequenceReader&lt;byte&gt; reader, out short value);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryReadLittleEndian(valuetype System.Buffers.SequenceReader`1&lt;unsigned int8&gt;&amp; reader, [out] int16&amp; value) cil managed" />
Expand Down
Loading
Loading