</assembly>
<members>
<member name="T:System.Buffers.ArrayBufferWriter`1">
- <summary>Represents a heap-based, array-backed output sink into which <typeparamref name="T" /> data can be written.</summary>
+ <summary>Represents a heap-based, array-backed output sink into which <typeparam name="T" /> data can be written.</summary>
<typeparam name="T">The type of the items in this <see cref="T:System.Buffers.ArrayBufferWriter`1" /> instance.</typeparam>
</member>
<member name="M:System.Buffers.ArrayBufferWriter`1.#ctor">
<paramref name="initialCapacity" /> is less than or equal to 0.</exception>
</member>
<member name="M:System.Buffers.ArrayBufferWriter`1.Advance(System.Int32)">
- <summary>Notifies the <see cref="T:System.Buffers.IBufferWriter`1" /> that <paramref name="count" /> items were written to the output <see cref="T:System.Span`1" />/<see cref="T:System.Memory`1" />.</summary>
+ <summary>Notifies the <see cref="T:System.Buffers.IBufferWriter`1" /> that <paramref name="count" /> items were written to the output <see cref="T:System.Span`1" />/<see cref="T:System.Memory`1" /></summary>
<param name="count">The number of items written.</param>
<exception cref="T:System.ArgumentException">
<paramref name="count" /> is negative.</exception>
<exception cref="T:System.InvalidOperationException">The method call attempts to advance past the end of the underlying buffer.</exception>
</member>
+ <member name="P:System.Buffers.ArrayBufferWriter`1.Capacity">
+ <summary>Gets the total amount of space within the underlying buffer.</summary>
+ <returns>The total capacity of the underlying buffer.</returns>
+ </member>
<member name="M:System.Buffers.ArrayBufferWriter`1.Clear">
<summary>Clears the data written to the underlying buffer.</summary>
</member>
+ <member name="P:System.Buffers.ArrayBufferWriter`1.FreeCapacity">
+ <summary>Gets the amount of available space that can be written to without forcing the underlying buffer to grow.</summary>
+ <returns>The space available for writing without forcing the underlying buffer to grow.</returns>
+ </member>
<member name="M:System.Buffers.ArrayBufferWriter`1.GetMemory(System.Int32)">
<summary>Returns a <see cref="T:System.Memory`1" /> to write to that is at least the length specified by <paramref name="sizeHint" />.</summary>
<param name="sizeHint">The minimum requested length of the <see cref="T:System.Memory`1" />.</param>
+ <returns>A <see cref="T:System.Memory`1" /> whose length is at least <paramref name="sizeHint" />. If <paramref name="sizeHint" /> is not provided or is equal to 0, some non-empty buffer is returned.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="sizeHint" /> is negative.</exception>
- <returns>A <see cref="T:System.Memory`1" /> whose length is at least <paramref name="sizeHint" />. If <paramref name="sizeHint" /> is not provided or is equal to 0, some non-empty buffer is returned.</returns>
</member>
<member name="M:System.Buffers.ArrayBufferWriter`1.GetSpan(System.Int32)">
<summary>Returns a <see cref="T:System.Span`1" /> to write to that is at least a specified length.</summary>
<param name="sizeHint">The minimum requested length of the <see cref="T:System.Span`1" />.</param>
+ <returns>A span of at least <paramref name="sizeHint" /> in length. If <paramref name="sizeHint" /> is not provided or is equal to 0, some non-empty buffer is returned.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="sizeHint" /> is negative.</exception>
- <returns>A span of at least <paramref name="sizeHint" /> in length. If <paramref name="sizeHint" /> is not provided or is equal to 0, some non-empty buffer is returned.</returns>
- </member>
- <member name="P:System.Buffers.ArrayBufferWriter`1.Capacity">
- <summary>Gets the total amount of space within the underlying buffer.</summary>
- <returns>The total capacity of the underlying buffer.</returns>
- </member>
- <member name="P:System.Buffers.ArrayBufferWriter`1.FreeCapacity">
- <summary>Gets the amount of available space that can be written to without forcing the underlying buffer to grow.</summary>
- <returns>The space available for writing without forcing the underlying buffer to grow.</returns>
</member>
<member name="P:System.Buffers.ArrayBufferWriter`1.WrittenCount">
<summary>Gets the amount of data written to the underlying buffer.</summary>
<member name="T:System.Buffers.Binary.BinaryPrimitives">
<summary>Reads bytes as primitives with specific endianness.</summary>
</member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.ReadDoubleBigEndian(System.ReadOnlySpan{System.Byte})">
- <summary>Reads a <see cref="T:System.Double" /> from the beginning of a read-only span of bytes, as big endian.</summary>
- <param name="source">The read-only span to read.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="source" /> is too small to contain a <see cref="T:System.Double" />.</exception>
- <returns>The big endian value.</returns>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.ReadDoubleLittleEndian(System.ReadOnlySpan{System.Byte})">
- <summary>Reads a <see cref="T:System.Double" /> from the beginning of a read-only span of bytes, as little endian.</summary>
- <param name="source">The read-only span to read.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="source" /> is too small to contain a <see cref="T:System.Double" />.</exception>
- <returns>The little endian value.</returns>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.ReadHalfBigEndian(System.ReadOnlySpan{System.Byte})">
- <summary>Reads a <see cref="T:System.Half" /> from the beginning of a read-only span of bytes, as big endian.</summary>
- <param name="source">The read-only span to read.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="source" /> is too small to contain a <see cref="T:System.Half" />.</exception>
- <returns>The big endian value.</returns>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.ReadHalfLittleEndian(System.ReadOnlySpan{System.Byte})">
- <summary>Reads a <see cref="T:System.Half" /> from the beginning of a read-only span of bytes, as little endian.</summary>
- <param name="source">The read-only span to read.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="source" /> is too small to contain a <see cref="T:System.Half" />.</exception>
- <returns>The little endian value.</returns>
- </member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.ReadInt16BigEndian(System.ReadOnlySpan{System.Byte})">
<summary>Reads an <see cref="T:System.Int16" /> from the beginning of a read-only span of bytes, as big endian.</summary>
<param name="source">The read-only span to read.</param>
+ <returns>The big endian value.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="source" /> is too small to contain an <see cref="T:System.Int16" />.</exception>
- <returns>The big endian value.</returns>
</member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.ReadInt16LittleEndian(System.ReadOnlySpan{System.Byte})">
<summary>Reads an <see cref="T:System.Int16" /> from the beginning of a read-only span of bytes, as little endian.</summary>
<param name="source">The read-only span to read.</param>
+ <returns>The little endian value.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="source" /> is too small to contain an <see cref="T:System.Int16" />.</exception>
- <returns>The little endian value.</returns>
</member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.ReadInt32BigEndian(System.ReadOnlySpan{System.Byte})">
<summary>Reads an <see cref="T:System.Int32" /> from the beginning of a read-only span of bytes, as big endian.</summary>
<param name="source">The read-only span to read.</param>
+ <returns>The big endian value.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="source" /> is too small to contain an <see cref="T:System.Int32" />.</exception>
- <returns>The big endian value.</returns>
</member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.ReadInt32LittleEndian(System.ReadOnlySpan{System.Byte})">
<summary>Reads an <see cref="T:System.Int32" /> from the beginning of a read-only span of bytes, as little endian.</summary>
<param name="source">The read-only span to read.</param>
+ <returns>The little endian value.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="source" /> is too small to contain an <see cref="T:System.Int32" />.</exception>
- <returns>The little endian value.</returns>
</member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.ReadInt64BigEndian(System.ReadOnlySpan{System.Byte})">
<summary>Reads an <see cref="T:System.Int64" /> from the beginning of a read-only span of bytes, as big endian.</summary>
<param name="source">The read-only span to read.</param>
+ <returns>The big endian value.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="source" /> is too small to contain an <see cref="T:System.Int64" />.</exception>
- <returns>The big endian value.</returns>
</member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.ReadInt64LittleEndian(System.ReadOnlySpan{System.Byte})">
<summary>Reads an <see cref="T:System.Int64" /> from the beginning of a read-only span of bytes, as little endian.</summary>
<param name="source">The read-only span to read.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="source" /> is too small to contain an <see cref="T:System.Int64" />.</exception>
<returns>The little endian value.</returns>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.ReadSingleBigEndian(System.ReadOnlySpan{System.Byte})">
- <summary>Reads a <see cref="T:System.Single" /> from the beginning of a read-only span of bytes, as big endian.</summary>
- <param name="source">The read-only span to read.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="source" /> is too small to contain a <see cref="T:System.Single" />.</exception>
- <returns>The big endian value.</returns>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.ReadSingleLittleEndian(System.ReadOnlySpan{System.Byte})">
- <summary>Reads a <see cref="T:System.Single" /> from the beginning of a read-only span of bytes, as little endian.</summary>
- <param name="source">The read-only span to read.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="source" /> is too small to contain a <see cref="T:System.Single" />.</exception>
- <returns>The little endian value.</returns>
+ <paramref name="source" /> is too small to contain an <see cref="T:System.Int64" />.</exception>
</member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.ReadUInt16BigEndian(System.ReadOnlySpan{System.Byte})">
<summary>Reads a <see cref="T:System.UInt16" /> from the beginning of a read-only span of bytes, as big endian.</summary>
<param name="source">The read-only span to read.</param>
+ <returns>The big endian value.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="source" /> is too small to contain a <see cref="T:System.UInt16" />.</exception>
- <returns>The big endian value.</returns>
</member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.ReadUInt16LittleEndian(System.ReadOnlySpan{System.Byte})">
<summary>Reads a <see cref="T:System.UInt16" /> from the beginning of a read-only span of bytes, as little endian.</summary>
<param name="source">The read-only span to read.</param>
+ <returns>The little endian value.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="source" /> is too small to contain a <see cref="T:System.UInt16" />.</exception>
- <returns>The little endian value.</returns>
</member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.ReadUInt32BigEndian(System.ReadOnlySpan{System.Byte})">
<summary>Reads a <see cref="T:System.UInt32" /> from the beginning of a read-only span of bytes, as big endian.</summary>
<param name="source">The read-only span to read.</param>
+ <returns>The big endian value.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="source" /> is too small to contain a <see cref="T:System.UInt32" />.</exception>
- <returns>The big endian value.</returns>
</member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.ReadUInt32LittleEndian(System.ReadOnlySpan{System.Byte})">
<summary>Reads a <see cref="T:System.UInt32" /> from the beginning of a read-only span of bytes, as little endian.</summary>
<param name="source">The read-only span of bytes to read.</param>
+ <returns>The little endian value.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="source" /> is too small to contain a <see cref="T:System.UInt32" />.</exception>
- <returns>The little endian value.</returns>
</member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.ReadUInt64BigEndian(System.ReadOnlySpan{System.Byte})">
<summary>Reads a <see cref="T:System.UInt64" /> from the beginning of a read-only span of bytes, as big endian.</summary>
<param name="source">The read-only span of bytes to read.</param>
+ <returns>The big endian value.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="source" /> is too small to contain a <see cref="T:System.UInt64" />.</exception>
- <returns>The big endian value.</returns>
</member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.ReadUInt64LittleEndian(System.ReadOnlySpan{System.Byte})">
<summary>Reads a <see cref="T:System.UInt64" /> from the beginning of a read-only span of bytes, as little endian.</summary>
<param name="source">The read-only span of bytes to read.</param>
+ <returns>The little endian value.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="source" /> is too small to contain a <see cref="T:System.UInt64" />.</exception>
- <returns>The little endian value.</returns>
</member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.Byte)">
<summary>Reverses a primitive value by performing an endianness swap of the specified <see cref="T:System.Byte" /> value, which effectively does nothing for a <see cref="T:System.Byte" />.</summary>
<param name="value">The value to reverse.</param>
<returns>The reversed value.</returns>
</member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.TryReadDoubleBigEndian(System.ReadOnlySpan{System.Byte},System.Double@)">
- <summary>Reads a <see cref="T:System.Double" /> from the beginning of a read-only span of bytes, as big endian.</summary>
- <param name="source">The read-only span of bytes to read.</param>
- <param name="value">When this method returns, contains the value read out of the read-only span of bytes, as big endian.</param>
- <returns>
- <see langword="true" /> if the span is large enough to contain a <see cref="T:System.Double" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.TryReadDoubleLittleEndian(System.ReadOnlySpan{System.Byte},System.Double@)">
- <summary>Reads a <see cref="T:System.Double" /> from the beginning of a read-only span of bytes, as little endian.</summary>
- <param name="source">The read-only span of bytes to read.</param>
- <param name="value">When this method returns, contains the value read out of the read-only span of bytes, as little endian.</param>
- <returns>
- <see langword="true" /> if the span is large enough to contain a <see cref="T:System.Double" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.TryReadHalfBigEndian(System.ReadOnlySpan{System.Byte},System.Half@)">
- <summary>Reads a <see cref="T:System.Half" /> from the beginning of a read-only span of bytes, as big endian.</summary>
- <param name="source">The read-only span of bytes to read.</param>
- <param name="value">When this method returns, the value read out of the read-only span of bytes, as big endian.</param>
- <returns>
- <see langword="true" /> if the span is large enough to contain a <see cref="T:System.Half" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.TryReadHalfLittleEndian(System.ReadOnlySpan{System.Byte},System.Half@)">
- <summary>Reads a <see cref="T:System.Half" /> from the beginning of a read-only span of bytes, as little endian.</summary>
- <param name="source">The read-only span of bytes to read.</param>
- <param name="value">When this method returns, the value read out of the read-only span of bytes, as little endian.</param>
- <returns>
- <see langword="true" /> if the span is large enough to contain a <see cref="T:System.Half" />; otherwise, <see langword="false" />.</returns>
- </member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.TryReadInt16BigEndian(System.ReadOnlySpan{System.Byte},System.Int16@)">
<summary>Reads an <see cref="T:System.Int16" /> from the beginning of a read-only span of bytes, as big endian.</summary>
<param name="source">The read-only span of bytes to read.</param>
<returns>
<see langword="true" /> if the span is large enough to contain an <see cref="T:System.Int64" />; otherwise, <see langword="false" />.</returns>
</member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.TryReadSingleBigEndian(System.ReadOnlySpan{System.Byte},System.Single@)">
- <summary>Reads a <see cref="T:System.Single" /> from the beginning of a read-only span of bytes, as big endian.</summary>
- <param name="source">The read-only span of bytes to read.</param>
- <param name="value">When this method returns, contains the value read out of the read-only span of bytes, as big endian.</param>
- <returns>
- <see langword="true" /> if the span is large enough to contain a <see cref="T:System.Single" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.TryReadSingleLittleEndian(System.ReadOnlySpan{System.Byte},System.Single@)">
- <summary>Reads a <see cref="T:System.Single" /> from the beginning of a read-only span of bytes, as little endian.</summary>
- <param name="source">The read-only span of bytes to read.</param>
- <param name="value">When this method returns, contains the value read out of the read-only span of bytes, as little endian.</param>
- <returns>
- <see langword="true" /> if the span is large enough to contain a <see cref="T:System.Single" />; otherwise, <see langword="false" />.</returns>
- </member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.TryReadUInt16BigEndian(System.ReadOnlySpan{System.Byte},System.UInt16@)">
<summary>Reads a <see cref="T:System.UInt16" /> from the beginning of a read-only span of bytes, as big endian.</summary>
<param name="source">The read-only span of bytes to read.</param>
<returns>
<see langword="true" /> if the span is large enough to contain a <see cref="T:System.UInt64" />; otherwise, <see langword="false" />.</returns>
</member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.TryWriteDoubleBigEndian(System.Span{System.Byte},System.Double)">
- <summary>Writes a <see cref="T:System.Double" /> into a span of bytes, as big endian.</summary>
- <param name="destination">The span of bytes where the value is to be written, as big endian.</param>
- <param name="value">The value to write into the span of bytes.</param>
- <returns>
- <see langword="true" /> if the span is large enough to contain a <see cref="T:System.Double" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.TryWriteDoubleLittleEndian(System.Span{System.Byte},System.Double)">
- <summary>Writes a <see cref="T:System.Double" /> into a span of bytes, as little endian.</summary>
- <param name="destination">The span of bytes where the value is to be written, as little endian.</param>
- <param name="value">The value to write into the span of bytes.</param>
- <returns>
- <see langword="true" /> if the span is large enough to contain a <see cref="T:System.Double" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.TryWriteHalfBigEndian(System.Span{System.Byte},System.Half)">
- <summary>Writes a <see cref="T:System.Half" /> into a span of bytes, as big endian.</summary>
- <param name="destination">The span of bytes where the value is to be written, as big endian.</param>
- <param name="value">The value to write into the span of bytes.</param>
- <returns>
- <see langword="true" /> if the span is large enough to contain a <see cref="T:System.Half" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.TryWriteHalfLittleEndian(System.Span{System.Byte},System.Half)">
- <summary>Writes a <see cref="T:System.Half" /> into a span of bytes, as little endian.</summary>
- <param name="destination">The span of bytes where the value is to be written, as little endian.</param>
- <param name="value">The value to write into the span of bytes.</param>
- <returns>
- <see langword="true" /> if the span is large enough to contain a <see cref="T:System.Half" />; otherwise, <see langword="false" />.</returns>
- </member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.TryWriteInt16BigEndian(System.Span{System.Byte},System.Int16)">
<summary>Writes an <see cref="T:System.Int16" /> into a span of bytes, as big endian.</summary>
<param name="destination">The span of bytes where the value is to be written, as big endian.</param>
<returns>
<see langword="true" /> if the span is large enough to contain an <see cref="T:System.Int64" />; otherwise, <see langword="false" />.</returns>
</member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.TryWriteSingleBigEndian(System.Span{System.Byte},System.Single)">
- <summary>Writes a <see cref="T:System.Single" /> into a span of bytes, as big endian.</summary>
- <param name="destination">The span of bytes where the value is to be written, as big endian.</param>
- <param name="value">The value to write into the span of bytes.</param>
- <returns>
- <see langword="true" /> if the span is large enough to contain a <see cref="T:System.Single" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.TryWriteSingleLittleEndian(System.Span{System.Byte},System.Single)">
- <summary>Writes a <see cref="T:System.Single" /> into a span of bytes, as little endian.</summary>
- <param name="destination">The span of bytes where the value is to be written, as little endian.</param>
- <param name="value">The value to write into the span of bytes.</param>
- <returns>
- <see langword="true" /> if the span is large enough to contain a <see cref="T:System.Single" />; otherwise, <see langword="false" />.</returns>
- </member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.TryWriteUInt16BigEndian(System.Span{System.Byte},System.UInt16)">
<summary>Writes a <see cref="T:System.UInt16" /> into a span of bytes, as big endian.</summary>
<param name="destination">The span of bytes where the value is to be written, as big endian.</param>
<returns>
<see langword="true" /> if the span is large enough to contain a <see cref="T:System.UInt64" />; otherwise, <see langword="false" />.</returns>
</member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.WriteDoubleBigEndian(System.Span{System.Byte},System.Double)">
- <summary>Writes a <see cref="T:System.Double" /> into a span of bytes, as big endian.</summary>
- <param name="destination">The span of bytes where the value is to be written, as big endian.</param>
- <param name="value">The value to write into the span of bytes.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="destination" /> is too small to contain a <see cref="T:System.Double" />.</exception>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.WriteDoubleLittleEndian(System.Span{System.Byte},System.Double)">
- <summary>Writes a <see cref="T:System.Double" /> into a span of bytes, as little endian.</summary>
- <param name="destination">The span of bytes where the value is to be written, as little endian.</param>
- <param name="value">The value to write into the span of bytes.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="destination" /> is too small to contain a <see cref="T:System.Double" />.</exception>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.WriteHalfBigEndian(System.Span{System.Byte},System.Half)">
- <summary>Writes a <see cref="T:System.Half" /> into a span of bytes, as big endian.</summary>
- <param name="destination">The span of bytes where the value is to be written, as big endian.</param>
- <param name="value">The value to write into the span of bytes.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="destination" /> is too small to contain a <see cref="T:System.Half" />.</exception>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.WriteHalfLittleEndian(System.Span{System.Byte},System.Half)">
- <summary>Writes a <see cref="T:System.Half" /> into a span of bytes, as little endian.</summary>
- <param name="destination">The span of bytes where the value is to be written, as little endian.</param>
- <param name="value">The value to write into the span of bytes.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="destination" /> is too small to contain a <see cref="T:System.Half" />.</exception>
- </member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.WriteInt16BigEndian(System.Span{System.Byte},System.Int16)">
<summary>Writes an <see cref="T:System.Int16" /> into a span of bytes, as big endian.</summary>
<param name="destination">The span of bytes where the value is to be written, as big endian.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="destination" /> is too small to contain an <see cref="T:System.Int64" />.</exception>
</member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.WriteSingleBigEndian(System.Span{System.Byte},System.Single)">
- <summary>Writes a <see cref="T:System.Single" /> into a span of bytes, as big endian.</summary>
- <param name="destination">The span of bytes where the value is to be written, as big endian.</param>
- <param name="value">The value to write into the span of bytes.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="destination" /> is too small to contain a <see cref="T:System.Single" />.</exception>
- </member>
- <member name="M:System.Buffers.Binary.BinaryPrimitives.WriteSingleLittleEndian(System.Span{System.Byte},System.Single)">
- <summary>Writes a <see cref="T:System.Single" /> into a span of bytes, as little endian.</summary>
- <param name="destination">The span of bytes where the value is to be written, as little endian.</param>
- <param name="value">The value to write into the span of bytes.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="destination" /> is too small to contain a <see cref="T:System.Single" />.</exception>
- </member>
<member name="M:System.Buffers.Binary.BinaryPrimitives.WriteUInt16BigEndian(System.Span{System.Byte},System.UInt16)">
<summary>Writes a <see cref="T:System.UInt16" /> into a span of bytes, as big endian.</summary>
<param name="destination">The span of bytes where the value is to be written, as big endian.</param>
<member name="M:System.Buffers.IBufferWriter`1.GetMemory(System.Int32)">
<summary>Returns a <see cref="T:System.Memory`1" /> to write to that is at least the requested size (specified by <paramref name="sizeHint" />).</summary>
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Memory`1" />. If 0, a non-empty buffer is returned.</param>
- <exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
<returns>A <see cref="T:System.Memory`1" /> of at least the size <paramref name="sizeHint" />. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer.</returns>
+ <exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
</member>
<member name="M:System.Buffers.IBufferWriter`1.GetSpan(System.Int32)">
<summary>Returns a <see cref="T:System.Span`1" /> to write to that is at least the requested size (specified by <paramref name="sizeHint" />).</summary>
<member name="M:System.Buffers.MemoryPool`1.Dispose(System.Boolean)">
<summary>Frees the unmanaged resources used by the memory pool and optionally releases the managed resources.</summary>
<param name="disposing">
- <see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
+ <see langword="true" /> to release both managed and unmanaged resources; to release only unmanaged resources.</param>
+ </member>
+ <member name="P:System.Buffers.MemoryPool`1.MaxBufferSize">
+ <summary>Gets the maximum buffer size supported by this pool.</summary>
+ <returns>The maximum buffer size supported by this pool.</returns>
</member>
<member name="M:System.Buffers.MemoryPool`1.Rent(System.Int32)">
<summary>Returns a memory block capable of holding at least <paramref name="minBufferSize" /> elements of T.</summary>
<param name="minBufferSize">The minimum number of elements of <typeparamref name="T" /> that the memory pool can hold. A value of -1 returns a memory pool set to the default size for the pool.</param>
<returns>A memory block capable of holding at least <paramref name="minBufferSize" /> elements of T.</returns>
</member>
- <member name="P:System.Buffers.MemoryPool`1.MaxBufferSize">
- <summary>Gets the maximum buffer size supported by this pool.</summary>
- <returns>The maximum buffer size supported by this pool.</returns>
- </member>
<member name="P:System.Buffers.MemoryPool`1.Shared">
<summary>Gets a singleton instance of a memory pool based on arrays.</summary>
<returns>A singleton instance of a memory pool.</returns>
</member>
+ <member name="T:System.Buffers.OperationStatus">
+ <summary>Defines the values that can be returned from span-based operations that support processing of input contained in multiple discontiguous buffers.</summary>
+ </member>
+ <member name="F:System.Buffers.OperationStatus.DestinationTooSmall">
+ <summary>The input is partially processed, up to what could fit into the destination buffer. The caller can enlarge the destination buffer, slice the buffers appropriately, and retry.</summary>
+ </member>
+ <member name="F:System.Buffers.OperationStatus.Done">
+ <summary>The entire input buffer has been processed and the operation is complete.</summary>
+ </member>
+ <member name="F:System.Buffers.OperationStatus.InvalidData">
+ <summary>The input contained invalid bytes which could not be processed. If the input is partially processed, the destination contains the partial result. This guarantees that no additional data appended to the input will make the invalid sequence valid.</summary>
+ </member>
+ <member name="F:System.Buffers.OperationStatus.NeedMoreData">
+ <summary>The input is partially processed, up to the last valid chunk of the input that could be consumed. The caller can stitch the remaining unprocessed input with more data, slice the buffers appropriately, and retry.</summary>
+ </member>
<member name="T:System.Buffers.ReadOnlySequence`1">
<summary>Represents a sequence that can read a sequential series of <typeparamref name="T" />.</summary>
- <typeparam name="T">The type of the elements in the read-only sequence.</typeparam>
- </member>
- <member name="F:System.Buffers.ReadOnlySequence`1.Empty">
- <summary>Returns an empty <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
+ <typeparam name="T" />
</member>
<member name="M:System.Buffers.ReadOnlySequence`1.#ctor(`0[])">
<summary>Creates an instance of <see cref="T:System.Buffers.ReadOnlySequence`1" /> from the <paramref name="array" />.</summary>
</member>
<member name="M:System.Buffers.ReadOnlySequence`1.#ctor(System.Buffers.ReadOnlySequenceSegment{`0},System.Int32,System.Buffers.ReadOnlySequenceSegment{`0},System.Int32)">
<summary>Creates an instance of a <see cref="T:System.Buffers.ReadOnlySequence`1" /> from a linked memory list represented by start and end segments and the corresponding indexes in them.</summary>
- <param name="startSegment">The initial node of the linked memory list.</param>
- <param name="startIndex">The position to the start of the sequence inside <paramref name="startSegment" />.</param>
- <param name="endSegment">The final node of the linked memory list.</param>
- <param name="endIndex">The position to the end of the sequence inside <paramref name="endSegment" />.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="startSegment" /> or <paramref name="endSegment" /> is <see langword="null" />.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The running index of <paramref name="startSegment" /> is greater than the running index of <paramref name="endSegment" />, even though <paramref name="startSegment" /> is different to <paramref name="endSegment" />.
-
--or-
-
-<paramref name="startSegment" /> is equal to <paramref name="endSegment" /> but <paramref name="endIndex" /> is smaller than <paramref name="startIndex" />.
-
--or-
-
-<paramref name="startIndex" /> is greater than the length of the underlying memory block of <paramref name="startSegment" />.</exception>
+ <param name="startSegment" />
+ <param name="startIndex" />
+ <param name="endSegment" />
+ <param name="endIndex" />
</member>
<member name="M:System.Buffers.ReadOnlySequence`1.#ctor(System.ReadOnlyMemory{`0})">
<summary>Creates an instance of <see cref="T:System.Buffers.ReadOnlySequence`1" /> from a <see cref="T:System.ReadOnlyMemory`1" />.</summary>
- <param name="memory">A read-only block of memory of elements of type <typeparamref name="T" />.</param>
+ <param name="memory" />
+ </member>
+ <member name="F:System.Buffers.ReadOnlySequence`1.Empty">
+ <summary>Returns an empty <see cref="T:System.Buffers.ReadOnlySequence`1" /></summary>
+ </member>
+ <member name="P:System.Buffers.ReadOnlySequence`1.End">
+ <summary>Gets the position at the end of the <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
+ </member>
+ <member name="T:System.Buffers.ReadOnlySequence`1.Enumerator">
+ <summary>Represents an enumerator over a <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
+ <typeparam name="T" />
+ </member>
+ <member name="M:System.Buffers.ReadOnlySequence`1.Enumerator.#ctor(System.Buffers.ReadOnlySequence{`0}@)">
+ <summary>Initializes the enumerator.</summary>
+ <param name="sequence">The <see cref="T:System.Buffers.ReadOnlySequence`1" /> to enumerate.</param>
+ </member>
+ <member name="P:System.Buffers.ReadOnlySequence`1.Enumerator.Current">
+ <summary>Gets the current <see cref="T:System.ReadOnlyMemory`1" />.</summary>
+ <returns>The current <see cref="T:System.ReadOnlyMemory`1" />.</returns>
+ </member>
+ <member name="M:System.Buffers.ReadOnlySequence`1.Enumerator.MoveNext">
+ <summary>Moves to the next <see cref="T:System.ReadOnlyMemory`1" /> in the <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
+ <returns>
+ <see langword="true" /> if the enumerator successfully advanced to the next item; <see langword="false" /> if the end of the sequence has been reached.</returns>
+ </member>
+ <member name="P:System.Buffers.ReadOnlySequence`1.First">
+ <summary>Gets the <see cref="T:System.ReadOnlyMemory`1" /> from the first segment.</summary>
+ </member>
+ <member name="P:System.Buffers.ReadOnlySequence`1.FirstSpan">
+ <summary>Gets the <see cref="T:System.ReadOnlySpan`1" /> from the first segment.</summary>
</member>
<member name="M:System.Buffers.ReadOnlySequence`1.GetEnumerator">
<summary>Returns an enumerator over the <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
<returns>Returns an enumerator over the <see cref="T:System.Buffers.ReadOnlySequence`1" />.</returns>
</member>
- <member name="M:System.Buffers.ReadOnlySequence`1.GetOffset(System.SequencePosition)">
- <summary>Returns the offset of a <paramref name="position" /> within this sequence from the start.</summary>
- <param name="position">The <see cref="T:System.SequencePosition" /> of which to get the offset.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">The position is out of range.</exception>
- <returns>The offset from the start of the sequence.</returns>
- </member>
<member name="M:System.Buffers.ReadOnlySequence`1.GetPosition(System.Int64)">
<summary>Returns a new <see cref="T:System.SequencePosition" /> at an <paramref name="offset" /> from the start of the sequence.</summary>
- <param name="offset">The offset from the start of the sequence.</param>
- <returns>An object representing the sequence position that starts at the specified <paramref name="offset" /> from the start of the sequence.</returns>
+ <param name="offset" />
</member>
<member name="M:System.Buffers.ReadOnlySequence`1.GetPosition(System.Int64,System.SequencePosition)">
- <summary>Returns a new <see cref="T:System.SequencePosition" /> starting at the specified offset from the <paramref name="origin" /> position.</summary>
- <param name="offset">The offset from the specified <paramref name="origin" /> sequence position.</param>
- <param name="origin">A sequence position representing the point from which to initiate the offset.</param>
- <returns>An object representing the sequence position that starts at the <paramref name="offset" /> position of the specified <paramref name="origin" /> position object.</returns>
+ <summary>Returns a new <see cref="T:System.SequencePosition" /> at an <paramref name="offset" /> from the <paramref name="origin" />.</summary>
+ <param name="offset" />
+ <param name="origin" />
+ <returns>A new object that starts at the <paramref name="offset" /> position of the original object.</returns>
+ </member>
+ <member name="P:System.Buffers.ReadOnlySequence`1.IsEmpty">
+ <summary>Gets a value that indicates whether the <see cref="T:System.Buffers.ReadOnlySequence`1" /> is empty.</summary>
+ </member>
+ <member name="P:System.Buffers.ReadOnlySequence`1.IsSingleSegment">
+ <summary>Gets a value that indicates whether the <see cref="T:System.Buffers.ReadOnlySequence`1" /> contains a single <see cref="T:System.ReadOnlyMemory`1" /> segment.</summary>
+ <returns>
+ <see langword="true" /> if the read-only sequence is empty; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Buffers.ReadOnlySequence`1.Length">
+ <summary>Gets the length of the <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
+ <returns>The length of the read-only sequence.</returns>
</member>
<member name="M:System.Buffers.ReadOnlySequence`1.Slice(System.Int32,System.Int32)">
<summary>Forms a slice out of the current <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at <paramref name="start" />, with <paramref name="length" /> items.</summary>
<param name="end">The ending (exclusive) <see cref="T:System.SequencePosition" /> of the slice.</param>
<returns>A slice that consists of items from the <paramref name="start" /> sequence position to, but not including, the <paramref name="end" /> sequence position in the current read-only sequence.</returns>
</member>
- <member name="M:System.Buffers.ReadOnlySequence`1.ToString">
- <summary>Returns a string that represents the current sequence.</summary>
- <returns>A string that represents the current sequence.</returns>
+ <member name="P:System.Buffers.ReadOnlySequence`1.Start">
+ <summary>Gets the position to the start of the <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
</member>
+ <member name="M:System.Buffers.ReadOnlySequence`1.ToString" />
<member name="M:System.Buffers.ReadOnlySequence`1.TryGet(System.SequencePosition@,System.ReadOnlyMemory{`0}@,System.Boolean)">
<summary>Tries to retrieve the next segment after <paramref name="position" /> and returns a value that indicates whether the operation succeeded.</summary>
<param name="position">The current sequence position.</param>
<see langword="true" /> if <paramref name="position" /> should to the beginning of next segment; otherwise, <see langword="false" />.</param>
<returns>Returns <see langword="true" /> if the method returned the next segment, or <see langword="false" /> if the end of the read-only sequence was reached.</returns>
</member>
- <member name="P:System.Buffers.ReadOnlySequence`1.End">
- <summary>Gets the position at the end of the <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
- </member>
- <member name="P:System.Buffers.ReadOnlySequence`1.First">
- <summary>Gets the <see cref="T:System.ReadOnlyMemory`1" /> from the first segment.</summary>
- </member>
- <member name="P:System.Buffers.ReadOnlySequence`1.FirstSpan">
- <summary>Gets the <see cref="T:System.ReadOnlySpan`1" /> from the first segment.</summary>
- </member>
- <member name="P:System.Buffers.ReadOnlySequence`1.IsEmpty">
- <summary>Gets a value that indicates whether the <see cref="T:System.Buffers.ReadOnlySequence`1" /> is empty.</summary>
- </member>
- <member name="P:System.Buffers.ReadOnlySequence`1.IsSingleSegment">
- <summary>Gets a value that indicates whether the <see cref="T:System.Buffers.ReadOnlySequence`1" /> contains a single <see cref="T:System.ReadOnlyMemory`1" /> segment.</summary>
- <returns>
- <see langword="true" /> if the read-only sequence is empty; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Buffers.ReadOnlySequence`1.Length">
- <summary>Gets the length of the <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
- <returns>The length of the read-only sequence.</returns>
- </member>
- <member name="P:System.Buffers.ReadOnlySequence`1.Start">
- <summary>Gets the position to the start of the <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
- </member>
- <member name="T:System.Buffers.ReadOnlySequence`1.Enumerator">
- <summary>Represents an enumerator over a <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
- <typeparam name="T" />
- </member>
- <member name="M:System.Buffers.ReadOnlySequence`1.Enumerator.#ctor(System.Buffers.ReadOnlySequence{`0}@)">
- <summary>Initializes the enumerator.</summary>
- <param name="sequence">The <see cref="T:System.Buffers.ReadOnlySequence`1" /> to enumerate.</param>
- </member>
- <member name="M:System.Buffers.ReadOnlySequence`1.Enumerator.MoveNext">
- <summary>Moves to the next <see cref="T:System.ReadOnlyMemory`1" /> in the <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
- <returns>
- <see langword="true" /> if the enumerator successfully advanced to the next item; <see langword="false" /> if the end of the sequence has been reached.</returns>
- </member>
- <member name="P:System.Buffers.ReadOnlySequence`1.Enumerator.Current">
- <summary>Gets the current <see cref="T:System.ReadOnlyMemory`1" />.</summary>
- <returns>The current <see cref="T:System.ReadOnlyMemory`1" />.</returns>
- </member>
<member name="T:System.Buffers.ReadOnlySequenceSegment`1">
<summary>Represents a linked list of <see cref="T:System.ReadOnlyMemory`1" /> nodes.</summary>
- <typeparam name="T">The type of the elements in the read-only sequence segment.</typeparam>
- </member>
- <member name="M:System.Buffers.ReadOnlySequenceSegment`1.#ctor">
- <summary>Initializes a new instance of the <see cref="T:System.Buffers.ReadOnlySequenceSegment`1" /> class.</summary>
+ <typeparam name="T" />
</member>
+ <member name="M:System.Buffers.ReadOnlySequenceSegment`1.#ctor" />
<member name="P:System.Buffers.ReadOnlySequenceSegment`1.Memory">
<summary>Gets or sets a <see cref="T:System.ReadOnlyMemory`1" /> value for the current node.</summary>
<returns>A <see cref="T:System.ReadOnlyMemory`1" /> value for the current node.</returns>
<param name="values">The values to be skipped.</param>
<returns>The number of positions the reader has advanced.</returns>
</member>
- <member name="M:System.Buffers.SequenceReader`1.AdvanceToEnd">
- <summary>Moves the reader to the end of the sequence.</summary>
+ <member name="P:System.Buffers.SequenceReader`1.Consumed">
+ <summary>Gets the total number of <typeparamref name="T" /> values processed by the reader.</summary>
+ <returns>The total number of values processed by the reader.</returns>
+ </member>
+ <member name="P:System.Buffers.SequenceReader`1.CurrentSpan">
+ <summary>Gets a <see cref="T:System.Span`1" /> that contains the current segment in the <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</summary>
+ <returns>A span that contains the current segment in the sequence.</returns>
+ </member>
+ <member name="P:System.Buffers.SequenceReader`1.CurrentSpanIndex">
+ <summary>Gets the index in the <see cref="P:System.Buffers.SequenceReader`1.CurrentSpan" />.</summary>
+ <returns>The index in the <see cref="P:System.Buffers.SequenceReader`1.CurrentSpan" />.</returns>
+ </member>
+ <member name="P:System.Buffers.SequenceReader`1.End">
+ <summary>Gets a value that indicates whether there is no more data in the <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</summary>
+ <returns>
+ <see langword="true" /> when there is no more data in the <see cref="P:System.Buffers.SequenceReader`1.Sequence" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Buffers.SequenceReader`1.IsNext(`0,System.Boolean)">
<summary>Checks whether a specified value is next in the sequence.</summary>
<returns>
<see langword="true" /> if the values are next in sequence; otherwise, <see langword="false" />.</returns>
</member>
+ <member name="P:System.Buffers.SequenceReader`1.Length">
+ <summary>Gets the count of items in the reader's <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</summary>
+ <returns>The count of items in the reader's <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</returns>
+ </member>
+ <member name="P:System.Buffers.SequenceReader`1.Position">
+ <summary>Gets the current position in the <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</summary>
+ <returns>The current position in the <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</returns>
+ </member>
+ <member name="P:System.Buffers.SequenceReader`1.Remaining">
+ <summary>Gets the remaining items in the reader's <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</summary>
+ <returns>The remaining items in the reader's <see cref="P:System.Buffers.SequenceReader`1.Sequence" /></returns>
+ </member>
<member name="M:System.Buffers.SequenceReader`1.Rewind(System.Int64)">
<summary>Moves the reader back the specified number of items.</summary>
<param name="count">The number of items.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="count" /> is negative or greater than <see cref="P:System.Buffers.SequenceReader`1.Consumed" />.</exception>
</member>
+ <member name="P:System.Buffers.SequenceReader`1.Sequence">
+ <summary>Gets the underlying <see cref="T:System.Buffers.ReadOnlySequence`1" /> for the reader.</summary>
+ <returns>The underlying read-only sequence for the reader.</returns>
+ </member>
<member name="M:System.Buffers.SequenceReader`1.TryAdvanceTo(`0,System.Boolean)">
<summary>Searches for a specified delimiter and optionally advances past it if it is found.</summary>
<param name="delimiter">The delimiter to search for.</param>
<summary>Searches for any of a number of specified delimiters and optionally advances past the first one to be found.</summary>
<param name="delimiters">The delimiters to search for.</param>
<param name="advancePastDelimiter">
- <see langword="true" /> to move past the first instance of any of the given <paramref name="delimiters" />; <see langword="false" /> to not move past the delimiter.</param>
+ <see langword="true" /> to move past the first instance of any of the given <paramref name="delimiters" />; to not move past the delimiter.</param>
<returns>
<see langword="true" /> if any of the given <paramref name="delimiters" /> was found; otherwise, <see langword="false" />.</returns>
</member>
<returns>
<see langword="true" /> if the reader is not at its end and the peek operation succeeded; <see langword="false" /> if at the end of the reader.</returns>
</member>
- <member name="M:System.Buffers.SequenceReader`1.TryPeek(System.Int64,`0@)">
- <summary>Peeks at the next value at the specified offset without advancing the reader.</summary>
- <param name="offset">The offset from current position.</param>
- <param name="value">The next value, or the default value if at the end of the reader.</param>
- <returns>
- <see langword="true" /> if the reader is not at its end and the peek operation succeeded; <see langword="false" /> if at the end of the reader.</returns>
- </member>
<member name="M:System.Buffers.SequenceReader`1.TryRead(`0@)">
<summary>Reads the next value and advance the reader.</summary>
<param name="value">The next value, or the default value if at the end of the reader.</param>
<returns>
<see langword="true" /> if the <paramref name="delimiter" /> was found; otherwise, <see langword="false" />.</returns>
</member>
- <member name="M:System.Buffers.SequenceReader`1.TryReadTo(System.ReadOnlySpan{`0}@,System.ReadOnlySpan{`0},System.Boolean)">
- <summary>Try to read everything up to the given <paramref name="delimiter" />.</summary>
- <param name="sequence">The read data, if any.</param>
- <param name="delimiter">The delimiter to look for.</param>
- <param name="advancePastDelimiter">
- <see langword="true" /> to move past the <paramref name="delimiter" /> if found.</param>
- <param name="span">The read data, if any.</param>
- <returns>
- <see langword="true" /> if the <paramref name="delimiter" /> was found; otherwise, <see langword="false" />.</returns>
- </member>
<member name="M:System.Buffers.SequenceReader`1.TryReadToAny(System.Buffers.ReadOnlySequence{`0}@,System.ReadOnlySpan{`0},System.Boolean)">
<summary>Tries to read everything up to any of the specified <paramref name="delimiters" />.</summary>
<param name="sequence">When the method returns, contains the data read, if any.</param>
<returns>
<see langword="true" /> if any of the <paramref name="delimiters" /> were found; otherwise, <see langword="false" />.</returns>
</member>
- <member name="P:System.Buffers.SequenceReader`1.Consumed">
- <summary>Gets the total number of <typeparamref name="T" /> values processed by the reader.</summary>
- <returns>The total number of values processed by the reader.</returns>
- </member>
- <member name="P:System.Buffers.SequenceReader`1.CurrentSpan">
- <summary>Gets a <see cref="T:System.Span`1" /> that contains the current segment in the <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</summary>
- <returns>A span that contains the current segment in the sequence.</returns>
- </member>
- <member name="P:System.Buffers.SequenceReader`1.CurrentSpanIndex">
- <summary>Gets the index in the <see cref="P:System.Buffers.SequenceReader`1.CurrentSpan" />.</summary>
- <returns>The index in the <see cref="P:System.Buffers.SequenceReader`1.CurrentSpan" />.</returns>
- </member>
- <member name="P:System.Buffers.SequenceReader`1.End">
- <summary>Gets a value that indicates whether there is no more data in the <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</summary>
- <returns>
- <see langword="true" /> when there is no more data in the <see cref="P:System.Buffers.SequenceReader`1.Sequence" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Buffers.SequenceReader`1.Length">
- <summary>Gets the count of items in the reader's <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</summary>
- <returns>The count of items in the reader's <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</returns>
- </member>
- <member name="P:System.Buffers.SequenceReader`1.Position">
- <summary>Gets the current position in the <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</summary>
- <returns>The current position in the <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</returns>
- </member>
- <member name="P:System.Buffers.SequenceReader`1.Remaining">
- <summary>Gets the remaining items in the reader's <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</summary>
- <returns>The remaining items in the reader's <see cref="P:System.Buffers.SequenceReader`1.Sequence" /></returns>
- </member>
- <member name="P:System.Buffers.SequenceReader`1.Sequence">
- <summary>Gets the underlying <see cref="T:System.Buffers.ReadOnlySequence`1" /> for the reader.</summary>
- <returns>The underlying read-only sequence for the reader.</returns>
- </member>
- <member name="P:System.Buffers.SequenceReader`1.UnreadSequence">
- <summary>Gets the unread portion of the <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</summary>
- <returns>The unread portion of the <see cref="P:System.Buffers.SequenceReader`1.Sequence" />.</returns>
- </member>
<member name="P:System.Buffers.SequenceReader`1.UnreadSpan">
<summary>Gets the unread portion of the <see cref="P:System.Buffers.SequenceReader`1.CurrentSpan" />.</summary>
<returns>The unread portion of the <see cref="P:System.Buffers.SequenceReader`1.CurrentSpan" />.</returns>
<member name="T:System.Buffers.StandardFormat">
<summary>Represents a standard format string without using an actual string.</summary>
</member>
- <member name="F:System.Buffers.StandardFormat.MaxPrecision">
- <summary>Defines the maximum valid precision value.</summary>
- </member>
- <member name="F:System.Buffers.StandardFormat.NoPrecision">
- <summary>Indicates that a format doesn't use a precision or that the precision is unspecified.</summary>
- </member>
<member name="M:System.Buffers.StandardFormat.#ctor(System.Char,System.Byte)">
<summary>Initializes a new instance of the <see cref="T:System.Buffers.StandardFormat" /> structure.</summary>
<param name="symbol">A type-specific format specifier, such as 'G', 'D', or 'X'.</param>
<param name="precision">An optional precision ranging from 0 to 99, or the special value <see cref="F:System.Buffers.StandardFormat.NoPrecision" /> (the default).</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="symbol" /> is not <see cref="F:System.Buffers.StandardFormat.NoPrecision" />, and its value is greater than <see cref="F:System.Buffers.StandardFormat.MaxPrecision" />.
-
-or-
-
<paramref name="symbol" /> cannot be converted to a <see cref="T:System.Byte" />.</exception>
</member>
<member name="M:System.Buffers.StandardFormat.Equals(System.Buffers.StandardFormat)">
<summary>Returns the hash code for this instance.</summary>
<returns>The hash code for this instance.</returns>
</member>
+ <member name="P:System.Buffers.StandardFormat.HasPrecision">
+ <summary>Gets a value that indicates whether a format has a defined precision.</summary>
+ <returns>
+ <see langword="true" /> if the format has a precision other than <see cref="F:System.Buffers.StandardFormat.NoPrecision" />; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Buffers.StandardFormat.IsDefault">
+ <summary>Gets a value that indicates whether the current instance is a default format.</summary>
+ <returns>
+ <see langword="true" /> if the current instance is a default format; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="F:System.Buffers.StandardFormat.MaxPrecision">
+ <summary>Defines the maximum valid precision value.</summary>
+ </member>
+ <member name="F:System.Buffers.StandardFormat.NoPrecision">
+ <summary>Indicates that a format doesn't use a precision or that the precision is unspecified.</summary>
+ </member>
<member name="M:System.Buffers.StandardFormat.op_Equality(System.Buffers.StandardFormat,System.Buffers.StandardFormat)">
<summary>Returns a value that indicates whether two <see cref="T:System.Buffers.StandardFormat" /> instances are equal.</summary>
<param name="left">The first format to compare.</param>
<member name="M:System.Buffers.StandardFormat.Parse(System.String)">
<summary>Converts a classic .NET standard format string to a <see cref="T:System.Buffers.StandardFormat" /> instance.</summary>
<param name="format">A classic .NET standard format string.</param>
+ <returns>A format.</returns>
<exception cref="T:System.FormatException">
<paramref name="format" /> is not a valid standard format string.</exception>
- <returns>A format.</returns>
+ </member>
+ <member name="P:System.Buffers.StandardFormat.Precision">
+ <summary>Gets the precision component of the format.</summary>
+ <returns>The precision component, which can be <see cref="F:System.Buffers.StandardFormat.NoPrecision" />, or can range from 0 to 9.</returns>
+ </member>
+ <member name="P:System.Buffers.StandardFormat.Symbol">
+ <summary>Gets the character component of the format.</summary>
+ <returns>The character component of the format.</returns>
</member>
<member name="M:System.Buffers.StandardFormat.ToString">
<summary>Returns the string representation of this format.</summary>
<returns>
<see langword="true" /> if the parsing operation was successful; otherwise, <see langword="false" />.</returns>
</member>
- <member name="P:System.Buffers.StandardFormat.HasPrecision">
- <summary>Gets a value that indicates whether a format has a defined precision.</summary>
- <returns>
- <see langword="true" /> if the format has a precision other than <see cref="F:System.Buffers.StandardFormat.NoPrecision" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Buffers.StandardFormat.IsDefault">
- <summary>Gets a value that indicates whether the current instance is a default format.</summary>
- <returns>
- <see langword="true" /> if the current instance is a default format; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Buffers.StandardFormat.Precision">
- <summary>Gets the precision component of the format.</summary>
- <returns>The precision component, which can be <see cref="F:System.Buffers.StandardFormat.NoPrecision" />, or can range from 0 to 9.</returns>
- </member>
- <member name="P:System.Buffers.StandardFormat.Symbol">
- <summary>Gets the character component of the format.</summary>
- <returns>The character component of the format.</returns>
- </member>
<member name="T:System.Buffers.Text.Base64">
<summary>Converts between binary data and UTF-8 encoded text that is represented in base 64.</summary>
</member>
<member name="M:System.Buffers.Text.Base64.GetMaxDecodedFromUtf8Length(System.Int32)">
<summary>Returns the maximum length (in bytes) of the result if you were to decode base-64 encoded text within a byte span with the specified length.</summary>
<param name="length">The size of the byte span.</param>
+ <returns>The maximum length (in bytes) of the result.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="length" /> is less than 0.</exception>
- <returns>The maximum length (in bytes) of the result.</returns>
</member>
<member name="M:System.Buffers.Text.Base64.GetMaxEncodedToUtf8Length(System.Int32)">
<summary>Returns the maximum length (in bytes) of the result if you were to encode binary data within a byte span with the specified length.</summary>
<param name="length">The size of the byte span.</param>
+ <returns>The maximum length (in bytes) of the result.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="length" /> is less than 0 or larger than 1610612733 (since encode inflates the data by 4/3).</exception>
- <returns>The maximum length (in bytes) of the result.</returns>
</member>
<member name="T:System.Buffers.Text.Utf8Formatter">
- <summary>Provides static methods to format common data types as Utf8 strings.</summary>
+ <summary>Provides static mthods to format common data types as Utf8 strings.</summary>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.Boolean,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats a <see cref="T:System.Boolean" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.Byte,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats a <see cref="T:System.Byte" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.DateTime,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats a <see cref="T:System.DateTime" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.DateTimeOffset,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats a <see cref="T:System.DateTimeOffset" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.Decimal,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats a <see cref="T:System.Decimal" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.Double,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats a <see cref="T:System.Double" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.Guid,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats a <see cref="T:System.Guid" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.Int16,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats an <see cref="T:System.Int16" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.Int32,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats an <see cref="T:System.Int32" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.Int64,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats an <see cref="T:System.Int64" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.SByte,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats an <see cref="T:System.SByte" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.Single,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats a <see cref="T:System.Single" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.TimeSpan,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats a <see cref="T:System.TimeSpan" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.UInt16,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats a <see cref="T:System.UInt16" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.UInt32,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats a <see cref="T:System.UInt32" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="M:System.Buffers.Text.Utf8Formatter.TryFormat(System.UInt64,System.Span{System.Byte},System.Int32@,System.Buffers.StandardFormat)">
<summary>Formats a <see cref="T:System.UInt64" /> as a UTF8 string.</summary>
<param name="bytesWritten">When the method returns, contains the length of the formatted text in bytes.</param>
<param name="format">The standard format to use.</param>
<returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
+ <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> if <paramref name="buffer" /> is too small.</returns>
</member>
<member name="T:System.Buffers.Text.Utf8Parser">
<summary>Provides static methods to parse Utf8 strings to common data types.</summary>
<see langword="true" /> for success; <see langword="false" /> if the string was not syntactically valid or an overflow or underflow occurred.</returns>
</member>
<member name="T:System.MemoryExtensions">
- <summary>Provides extension methods for the memory- and span-related types, such as <see cref="T:System.Memory`1" />, <see cref="T:System.ReadOnlyMemory`1" />, <see cref="T:System.Span`1" />, and <see cref="T:System.ReadOnlySpan`1" />.</summary>
+ <summary>Provides extension methods for for the memory- and span-related types, such as <see cref="T:System.Memory`1" />, <see cref="T:System.ReadOnlyMemory`1" />, <see cref="T:System.Span`1" />, and <see cref="T:System.ReadOnlySpan`1" />.</summary>
</member>
<member name="M:System.MemoryExtensions.AsMemory(System.String)">
<summary>Creates a new <see langword="ReadOnlyMemory<Char>" /> over the portion of the target string.</summary>
<summary>Creates a new <see langword="ReadOnlyMemory<Char>" /> over a portion of the target string starting at a specified character position.</summary>
<param name="text">The target string.</param>
<param name="start">The index at which to begin this slice.</param>
+ <returns>The read-only character memory representation of the string, or <see langword="default" /> if <paramref name="text" /> is <see langword="null" />.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="start" /> is not in the range of <paramref name="text" /> (<paramref name="start" /> is < 0 or > <c>text.Length</c>).</exception>
- <returns>The read-only character memory representation of the string, or <see langword="default" /> if <paramref name="text" /> is <see langword="null" />.</returns>
</member>
<member name="M:System.MemoryExtensions.AsMemory(System.String,System.Int32,System.Int32)">
<summary>Creates a new <see langword="ReadOnlyMemory<Char>" /> over a portion of the target string beginning at a specified position with a length.</summary>
<param name="text">The target string.</param>
<param name="start">The index at which to begin this slice.</param>
<param name="length">The desired length for the slice.</param>
+ <returns>The read-only character memory representation of the string, or <see langword="default" /> if <paramref name="text" /> is <see langword="null" />.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="start" />, <paramref name="length" />, or <paramref name="start" /> + <paramref name="length" /> is not in the range of <paramref name="text" />.</exception>
- <returns>The read-only character memory representation of the string, or <see langword="default" /> if <paramref name="text" /> is <see langword="null" />.</returns>
</member>
<member name="M:System.MemoryExtensions.AsMemory(System.String,System.Range)">
<summary>Creates a new <see langword="ReadOnlyMemory<Char>" /> over a specified range of the target string.</summary>
<param name="array">The target array.</param>
<param name="start">The index at which to begin the memory.</param>
<typeparam name="T">The type of the array.</typeparam>
+ <returns>The memory representation of the whole or part of the array.</returns>
<exception cref="T:System.ArrayTypeMismatchException">
<paramref name="array" /> is covariant, and the array's type is not exactly <see langword="T[]" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="start" /> index less than 0 or greater than <see langword="array.Length" />.</exception>
- <returns>The memory representation of the whole or part of the array.</returns>
</member>
<member name="M:System.MemoryExtensions.AsMemory``1(``0[],System.Int32,System.Int32)">
<summary>Creates a new memory region over the portion of the target array beginning at a specified position with a specified length.</summary>
<param name="start">The index at which to begin the memory region.</param>
<param name="length">The number of items in the memory region.</param>
<typeparam name="T">The type of the array.</typeparam>
+ <returns>The memory representation of the whole or part of the array.</returns>
<exception cref="T:System.ArrayTypeMismatchException">
<paramref name="array" /> is covariant, and the array's type is not exactly <see langword="T[]" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="start" />, <paramref name="length" />, or <paramref name="start" /> + <paramref name="length" /> is not in the range of <paramref name="array" />.</exception>
- <returns>The memory representation of the whole or part of the array.</returns>
</member>
<member name="M:System.MemoryExtensions.AsMemory``1(``0[],System.Range)">
<summary>Creates a new memory region over the portion of the target array beginning at inclusive start index of the range and ending at the exclusive end index of the range.</summary>
<param name="segment">The target array segment.</param>
<param name="start">The index at which to begin the memory.</param>
<typeparam name="T">The type of the array.</typeparam>
+ <returns>The memory representation of the whole or part of the array.</returns>
<exception cref="T:System.ArrayTypeMismatchException">
<paramref name="segment" /> is covariant, and the type of <paramref name="segment" /> is not exactly <see langword="T[]" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="start" /> is less than 0 or greater than <see langword="segment.Count" />.</exception>
- <returns>The memory representation of the whole or part of the array.</returns>
</member>
<member name="M:System.MemoryExtensions.AsMemory``1(System.ArraySegment{``0},System.Int32,System.Int32)">
<summary>Creates a new memory region over the portion of the target array segment beginning at a specified position with a specified length.</summary>
<param name="start">The index at which to begin the memory.</param>
<param name="length">The number of items in the memory.</param>
<typeparam name="T">The type of the array.</typeparam>
+ <returns>The memory representation of the whole or part of the array.</returns>
<exception cref="T:System.ArrayTypeMismatchException">
<paramref name="segment" /> is covariant, and the array's type is not exactly <see langword="T[]" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="start" />, <paramref name="length" />, or <paramref name="start" /> + <paramref name="length" /> is not in the range of <paramref name="segment" />.</exception>
- <returns>The memory representation of the whole or part of the array.</returns>
</member>
<member name="M:System.MemoryExtensions.AsSpan(System.String)">
<summary>Creates a new read-only span over a portion of the target string from a specified position for a specified number of characters.</summary>
<summary>Creates a new read-only span over a portion of the target string from a specified position to the end of the string.</summary>
<param name="text">The target string.</param>
<param name="start">The index at which to begin this slice.</param>
+ <returns>The read-only span representation of the string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="text" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="start" /> is less than 0 or greater than <see langword="text.Length" />.</exception>
- <returns>The read-only span representation of the string.</returns>
</member>
<member name="M:System.MemoryExtensions.AsSpan(System.String,System.Int32,System.Int32)">
<summary>Creates a new read-only span over a string.</summary>
<param name="text">The target string.</param>
<param name="start">The index at which to begin this slice.</param>
<param name="length">The desired length for the slice.</param>
+ <returns>The read-only span representation of the string.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="start" />, <paramref name="length" />, or <paramref name="start" /> + <paramref name="length" /> is not in the range of <paramref name="text" />.</exception>
- <returns>The read-only span representation of the string.</returns>
</member>
<member name="M:System.MemoryExtensions.AsSpan``1(``0[])">
<summary>Creates a new span over a target array.</summary>
<param name="start">The index at which to begin the span.</param>
<param name="length">The number of items in the span.</param>
<typeparam name="T">The type of the array.</typeparam>
+ <returns>The span representation of the array.</returns>
<exception cref="T:System.ArrayTypeMismatchException">
<paramref name="array" /> is covariant, and the array's type is not exactly <see langword="T[]" />".</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="start" />, <paramref name="length" />, or <paramref name="start" /> + <paramref name="length" /> is not in the range of <paramref name="text" />.</exception>
- <returns>The span representation of the array.</returns>
</member>
<member name="M:System.MemoryExtensions.AsSpan``1(``0[],System.Range)">
<summary>Creates a new span over a portion of a target array defined by a <see cref="T:System.Range" /> value.</summary>
<param name="segment">The target array segment.</param>
<param name="start">The index at which to begin the san.</param>
<typeparam name="T">The type of the array segment.</typeparam>
+ <returns>The span representation of the array segment.</returns>
<exception cref="T:System.ArrayTypeMismatchException">
<paramref name="segment" /> is covariant, and the array's type is not exactly <see langword="T[]" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="start" /> is less than 0 or greater than <see langword="segment.Count" />.</exception>
- <returns>The span representation of the array segment.</returns>
</member>
<member name="M:System.MemoryExtensions.AsSpan``1(System.ArraySegment{``0},System.Int32,System.Int32)">
<summary>Creates a new span over a portion of a target array segment from a specified position for a specified length.</summary>
<param name="start">The index at which to begin the span.</param>
<param name="length">The number of items in the span.</param>
<typeparam name="T">The type of the array segment.</typeparam>
+ <returns>The span representation of the array.</returns>
<exception cref="T:System.ArrayTypeMismatchException">
<paramref name="segment" /> is covariant, and the array's type is not exactly <see langword="T[]" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="start" />, <paramref name="length" />, or <paramref name="start" /> + <paramref name="length" /> is not in the range of <paramref name="segment" />.</exception>
- <returns>The span representation of the array.</returns>
</member>
<member name="M:System.MemoryExtensions.AsSpan``1(System.ArraySegment{``0},System.Range)">
<summary>Creates a new span over a portion of a target array segment using the range start and end indexes.</summary>
<param name="span">The sorted <see cref="T:System.ReadOnlySpan`1" /> to search.</param>
<param name="comparable">The <see cref="T:System.IComparable`1" /> to use when comparing.</param>
<typeparam name="T">The element type of the span.</typeparam>
+ <returns>The zero-based index of <paramref name="comparable" /> in the sorted <paramref name="span" />, if <paramref name="comparable" /> is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="comparable" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.ReadOnlySpan`1.Length" />.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="comparable" /> is <see langword="null" />.</exception>
- <returns>The zero-based index of <paramref name="comparable" /> in the sorted <paramref name="span" />, if <paramref name="comparable" /> is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="comparable" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.ReadOnlySpan`1.Length" />.</returns>
</member>
<member name="M:System.MemoryExtensions.BinarySearch``1(System.Span{``0},System.IComparable{``0})">
<summary>Searches an entire sorted <see cref="T:System.Span`1" /> for a value using the specified <see cref="T:System.IComparable`1" /> generic interface.</summary>
<param name="span">The sorted <see cref="T:System.Span`1" /> to search.</param>
<param name="comparable">The <see cref="T:System.IComparable`1" /> to use when comparing.</param>
<typeparam name="T">The element type of the span.</typeparam>
+ <returns>The zero-based index of <paramref name="comparable" /> in the sorted <paramref name="span" />, if <paramref name="comparable" /> is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="comparable" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.Span`1.Length" />.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="comparable" /> is <see langword="null" />.</exception>
- <returns>The zero-based index of <paramref name="comparable" /> in the sorted <paramref name="span" />, if <paramref name="comparable" /> is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="comparable" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.Span`1.Length" />.</returns>
</member>
<member name="M:System.MemoryExtensions.BinarySearch``2(System.ReadOnlySpan{``0},``0,``1)">
<summary>Searches an entire sorted <see cref="T:System.ReadOnlySpan`1" /> for a specified value using the specified <typeparamref name="TComparer" /> generic type.</summary>
<param name="comparer">The <typeparamref name="TComparer" /> to use when comparing.</param>
<typeparam name="T">The element type of the span.</typeparam>
<typeparam name="TComparer">The specific type of <see cref="T:System.Collections.Generic.IComparer`1" />.</typeparam>
+ <returns>The zero-based index of <paramref name="value" /> in the sorted <paramref name="span" />, if <paramref name="value" /> is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="value" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.ReadOnlySpan`1.Length" />.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="comparer" /> is <see langword="null" />.</exception>
- <returns>The zero-based index of <paramref name="value" /> in the sorted <paramref name="span" />, if <paramref name="value" /> is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="value" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.ReadOnlySpan`1.Length" />.</returns>
</member>
<member name="M:System.MemoryExtensions.BinarySearch``2(System.ReadOnlySpan{``0},``1)">
<summary>Searches an entire sorted <see cref="T:System.ReadOnlySpan`1" /> for a value using the specified <typeparamref name="TComparable" /> generic type.</summary>
<param name="comparable">The <typeparamref name="TComparable" /> to use when comparing.</param>
<typeparam name="T">The element type of the span.</typeparam>
<typeparam name="TComparable">The specific type of <see cref="T:System.IComparable`1" />.</typeparam>
+ <returns>The zero-based index of <paramref name="comparable" /> in the sorted <paramref name="span" />, if <paramref name="comparable" /> is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="comparable" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.ReadOnlySpan`1.Length" />.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="comparable" /> is <see langword="null" />.</exception>
- <returns>The zero-based index of <paramref name="comparable" /> in the sorted <paramref name="span" />, if <paramref name="comparable" /> is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="comparable" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.ReadOnlySpan`1.Length" />.</returns>
</member>
<member name="M:System.MemoryExtensions.BinarySearch``2(System.Span{``0},``0,``1)">
<summary>Searches an entire sorted <see cref="T:System.Span`1" /> for a specified value using the specified <typeparamref name="TComparer" /> generic type.</summary>
<param name="comparer">The <typeparamref name="TComparer" /> to use when comparing.</param>
<typeparam name="T">The element type of the span.</typeparam>
<typeparam name="TComparer">The specific type of <see cref="T:System.Collections.Generic.IComparer`1" />.</typeparam>
+ <returns>The zero-based index of <paramref name="value" /> in the sorted <paramref name="span" />, if <paramref name="value" /> is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="value" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.Span`1.Length" />.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="comparer" /> is <see langword="null" />.</exception>
- <returns>The zero-based index of <paramref name="value" /> in the sorted <paramref name="span" />, if <paramref name="value" /> is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="value" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.Span`1.Length" />.</returns>
</member>
<member name="M:System.MemoryExtensions.BinarySearch``2(System.Span{``0},``1)">
<summary>Searches an entire sorted <see cref="T:System.Span`1" /> for a value using the specified <typeparamref name="TComparable" /> generic type.</summary>
<param name="comparable">The <typeparamref name="TComparable" /> to use when comparing.</param>
<typeparam name="T">The element type of the span.</typeparam>
<typeparam name="TComparable">The specific type of <see cref="T:System.IComparable`1" />.</typeparam>
+ <returns>The zero-based index of <paramref name="comparable" /> in the sorted <paramref name="span" />, if <paramref name="comparable" /> is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="comparable" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.Span`1.Length" />.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="comparable" /> is <see langword="null" />.</exception>
- <returns>The zero-based index of <paramref name="comparable" /> in the sorted <paramref name="span" />, if <paramref name="comparable" /> is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="comparable" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.Span`1.Length" />.</returns>
</member>
<member name="M:System.MemoryExtensions.CompareTo(System.ReadOnlySpan{System.Char},System.ReadOnlySpan{System.Char},System.StringComparison)">
<summary>Compares one character span with another using a specified string comparison, and returns an integer that indicates their relative position in the sort order.</summary>
<param name="span">The source span.</param>
<param name="other">The value to compare with the source span.</param>
<param name="comparisonType">An enumeration value that determines how <paramref name="span" /> and <paramref name="other" /> are compared.</param>
- <returns>A signed integer that indicates the relative order of <paramref name="span" /> and <paramref name="other" />:
<br /> - If less than 0, <paramref name="span" /> precedes than <paramref name="other" />.<br /> - If 0, <paramref name="span" /> equals <paramref name="other" />.<br /> - If greater than 0, <paramref name="span" /> follows <paramref name="other" />.</returns>
+ <returns>A signed integer that indicates the relative order of <paramref name="span" /> and <paramref name="other" />:
- If less than 0, <paramref name="span" /> precedes than <paramref name="other" />. - If 0, <paramref name="span" /> equals <paramref name="other" />. - If greater than 0, <paramref name="span" /> follows <paramref name="other" />.</returns>
</member>
<member name="M:System.MemoryExtensions.Contains(System.ReadOnlySpan{System.Char},System.ReadOnlySpan{System.Char},System.StringComparison)">
<summary>Indicates whether a specified value occurs within a read-only character span.</summary>
<returns>
<see langword="true" /> if <paramref name="value" /> matches the end of <paramref name="span" />; otherwise, <see langword="false" />.</returns>
</member>
- <member name="M:System.MemoryExtensions.EnumerateLines(System.ReadOnlySpan{System.Char})">
- <summary>Returns an enumeration of lines over the provided span.</summary>
- <param name="span">A span containing the lines to enumerate.</param>
- <returns>An enumeration of lines.</returns>
- </member>
- <member name="M:System.MemoryExtensions.EnumerateLines(System.Span{System.Char})">
- <summary>Returns an enumeration of lines over the provided span.</summary>
- <param name="span">A span containing the lines to enumerate.</param>
- <returns>An enumeration of lines.</returns>
- </member>
<member name="M:System.MemoryExtensions.EnumerateRunes(System.ReadOnlySpan{System.Char})">
<summary>Returns an enumeration of <see cref="T:System.Text.Rune" /> from the provided read-only span.</summary>
<param name="span">The source span.</param>
<summary>Searches for the specified sequence and returns the index of its first occurrence. Values are compared using IEquatable{T}.Equals(T).</summary>
<param name="span">The span to search.</param>
<param name="value">The sequence to search for.</param>
- <typeparam name="T">The type of the span and value.</typeparam>
+ <typeparam name="T">The type of the span and value..</typeparam>
<returns>The index of the occurrence of the value in the span. If not found, returns -1.</returns>
</member>
<member name="M:System.MemoryExtensions.IndexOfAny``1(System.ReadOnlySpan{``0},``0,``0)">
<summary>Determines whether two read-only sequences overlap in memory.</summary>
<param name="span">The first sequence.</param>
<param name="other">The second sequence.</param>
- <typeparam name="T">The type of elements in the read-only sequence.</typeparam>
+ <typeparam name="T">The type of elmeents in the read-only sequence.</typeparam>
<returns>
<see langword="true" /> if the two sequences overlap; otherwise, <see langword="false" />.</returns>
</member>
<summary>Determines whether two read-only sequences overlap in memory and outputs the element offset.</summary>
<param name="span">The first sequence.</param>
<param name="other">The second sequence.</param>
- <param name="elementOffset">When the method returns, contains the offset between <paramref name="span" /> and <paramref name="other" />.</param>
+ <param name="elementOffset" />
<typeparam name="T">The type of elements in the span.</typeparam>
<returns>
<see langword="true" /> if the two sequences overlap; otherwise, <see langword="false" />.</returns>
<param name="span">The first sequence to compare.</param>
<param name="other">The second sequence to compare.</param>
<typeparam name="T">The type of elements in the sequence.</typeparam>
- <returns>A signed integer that indicates the relative order of <paramref name="span" /> and <paramref name="other" />:
<br /> - If less than 0, <paramref name="span" /> precedes than <paramref name="other" />.<br /> - If 0, <paramref name="span" /> equals <paramref name="other" />.<br /> - If greater than 0, <paramref name="span" /> follows <paramref name="other" />.</returns>
+ <returns>A signed integer that indicates the relative order of <paramref name="span" /> and <paramref name="other" />:
- If less than 0, <paramref name="span" /> precedes than <paramref name="other" />. - If 0, <paramref name="span" /> equals <paramref name="other" />. - If greater than 0, <paramref name="span" /> follows <paramref name="other" />.</returns>
</member>
<member name="M:System.MemoryExtensions.SequenceCompareTo``1(System.Span{``0},System.ReadOnlySpan{``0})">
<summary>Determines the relative order of a span and a read-only span by comparing the elements using IComparable{T}.CompareTo(T).</summary>
<param name="span">The span to compare.</param>
<param name="other">The read-only span to compare.</param>
<typeparam name="T">The type of elements in the span.</typeparam>
- <returns>A signed integer that indicates the relative order of <paramref name="span" /> and <paramref name="other" />:
<br /> - If less than 0, <paramref name="span" /> precedes than <paramref name="other" />.<br /> - If 0, <paramref name="span" /> equals <paramref name="other" />.<br /> - If greater than 0, <paramref name="span" /> follows <paramref name="other" />.</returns>
+ <returns>A signed integer that indicates the relative order of <paramref name="span" /> and <paramref name="other" />:
- If less than 0, <paramref name="span" /> precedes than <paramref name="other" />. - If 0, <paramref name="span" /> equals <paramref name="other" />. - If greater than 0, <paramref name="span" /> follows <paramref name="other" />.</returns>
</member>
<member name="M:System.MemoryExtensions.SequenceEqual``1(System.ReadOnlySpan{``0},System.ReadOnlySpan{``0})">
<summary>Determines whether two read-only sequences are equal by comparing the elements using IEquatable{T}.Equals(T).</summary>
<returns>
<see langword="true" /> if the two sequences are equal; otherwise, <see langword="false" />.</returns>
</member>
- <member name="M:System.MemoryExtensions.SequenceEqual``1(System.ReadOnlySpan{``0},System.ReadOnlySpan{``0},System.Collections.Generic.IEqualityComparer{``0})">
- <summary>Determines whether two sequences are equal by comparing the elements using an <see cref="T:System.Collections.Generic.IEqualityComparer`1" />.</summary>
- <param name="span">The first sequence to compare.</param>
- <param name="other">The second sequence to compare.</param>
- <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> implementation to use when comparing elements, or <see langword="null" /> to use the default <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> for the type of an element.</param>
- <typeparam name="T">The type of elements in the sequence.</typeparam>
- <returns>
- <see langword="true" /> if the two sequences are equal; otherwise, <see langword="false" />.</returns>
- </member>
<member name="M:System.MemoryExtensions.SequenceEqual``1(System.Span{``0},System.ReadOnlySpan{``0})">
<summary>Determines whether a span and a read-only span are equal by comparing the elements using IEquatable{T}.Equals(T).</summary>
<param name="span">The span to compare.</param>
<returns>
<see langword="true" /> if the two sequences are equal; otherwise, <see langword="false" />.</returns>
</member>
- <member name="M:System.MemoryExtensions.SequenceEqual``1(System.Span{``0},System.ReadOnlySpan{``0},System.Collections.Generic.IEqualityComparer{``0})">
- <summary>Determines whether two sequences are equal by comparing the elements using an <see cref="T:System.Collections.Generic.IEqualityComparer`1" />.</summary>
- <param name="span">The first sequence to compare.</param>
- <param name="other">The second sequence to compare.</param>
- <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> implementation to use when comparing elements, or <see langword="null" /> to use the default <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> for the type of an element.</param>
- <typeparam name="T">The type of elements in the sequence.</typeparam>
- <returns>
- <see langword="true" /> if the two sequences are equal; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="M:System.MemoryExtensions.Sort``1(System.Span{``0})">
- <summary>Sorts the elements in the entire <see cref="T:System.Span`1" /> using the <see cref="T:System.IComparable`1" /> implementation of each element of the <see cref="T:System.Span`1" />.</summary>
- <param name="span">The span of memory to sort.</param>
- <typeparam name="T">The type of the elements of the span.</typeparam>
- <exception cref="T:System.InvalidOperationException">One or more elements in <paramref name="span" /> do not implement the <see cref="T:System.IComparable`1" /> interface.</exception>
- </member>
- <member name="M:System.MemoryExtensions.Sort``1(System.Span{``0},System.Comparison{``0})">
- <summary>Sorts the elements in the entire <see cref="T:System.Span`1" /> using the specified <see cref="T:System.Comparison`1" />.</summary>
- <param name="span">The span of memory to sort.</param>
- <param name="comparison">The method to use when comparing elements.</param>
- <typeparam name="T">The type of the elements of the span.</typeparam>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="comparison" /> is <see langword="null" />.</exception>
- </member>
- <member name="M:System.MemoryExtensions.Sort``2(System.Span{``0},``1)">
- <summary>Sorts the elements in the entire <see cref="T:System.Span`1" /> using the <typeparamref name="TComparer" />.</summary>
- <param name="span">The span of memory to sort.</param>
- <param name="comparer">The method to use when comparing elements, or <see langword="null" /> to use each element's <see cref="T:System.IComparable`1" /> interface implementation.</param>
- <typeparam name="T">The type of the elements of the span.</typeparam>
- <typeparam name="TComparer">The type of the comparer to use to compare elements.</typeparam>
- <exception cref="T:System.InvalidOperationException">
- <paramref name="comparer" /> is <see langword="null" />, and one or more elements in <paramref name="span" /> do not implement the <see cref="T:System.IComparable`1" /> interface.</exception>
- <exception cref="T:System.ArgumentException">The implementation of <paramref name="comparer" /> caused an error during the sort.</exception>
- </member>
- <member name="M:System.MemoryExtensions.Sort``2(System.Span{``0},System.Span{``1})">
- <summary>Sorts a pair of spans (one containing the keys and the other containing the corresponding items) based on the keys in the first <see cref="T:System.Span`1" /> using the <see cref="T:System.IComparable`1" /> implementation of each key.</summary>
- <param name="keys">The span that contains the keys to sort.</param>
- <param name="items">The span that contains the items that correspond to the keys in <paramref name="keys" />.</param>
- <typeparam name="TKey">The type of the elements of the key span.</typeparam>
- <typeparam name="TValue">The type of the elements of the items span.</typeparam>
- <exception cref="T:System.ArgumentException">The length of <paramref name="keys" /> isn't equal to the length of <paramref name="items" />.</exception>
- <exception cref="T:System.InvalidOperationException">One or more elements in <paramref name="keys" /> do not implement the <see cref="T:System.IComparable`1" /> interface.</exception>
- </member>
- <member name="M:System.MemoryExtensions.Sort``2(System.Span{``0},System.Span{``1},System.Comparison{``0})">
- <summary>Sorts a pair of spans (one containing the keys and the other containing the corresponding items) based on the keys in the first <see cref="T:System.Span`1" /> using the specified comparison.</summary>
- <param name="keys">The span that contains the keys to sort.</param>
- <param name="items">The span that contains the items that correspond to the keys in <paramref name="keys" />.</param>
- <param name="comparison">The <see cref="T:System.Comparison`1" /> to use when comparing elements.</param>
- <typeparam name="TKey">The type of the elements of the key span.</typeparam>
- <typeparam name="TValue">The type of the elements of the items span.</typeparam>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="comparison" /> is <see langword="null" />.</exception>
- <exception cref="T:System.ArgumentException">The length of <paramref name="keys" /> isn't equal to the length of <paramref name="items" />.</exception>
- </member>
- <member name="M:System.MemoryExtensions.Sort``3(System.Span{``0},System.Span{``1},``2)">
- <summary>Sorts a pair of spans (one containing the keys and the other containing the corresponding items) based on the keys in the first <see cref="T:System.Span`1" /> using the specified comparer.</summary>
- <param name="keys">The span that contains the keys to sort.</param>
- <param name="items">The span that contains the items that correspond to the keys in <paramref name="keys" />.</param>
- <param name="comparer">The <see cref="T:System.Collections.Generic.IComparer`1" /> implementation to use when comparing elements, or <see langword="null" /> to use the <see cref="T:System.IComparable`1" /> interface implementation of each element.</param>
- <typeparam name="TKey">The type of the elements of the key span.</typeparam>
- <typeparam name="TValue">The type of the elements of the items span.</typeparam>
- <typeparam name="TComparer">The type of the comparer to use to compare elements.</typeparam>
- <exception cref="T:System.ArgumentException">The length of <paramref name="keys" /> isn't equal to the length of <paramref name="items" />.</exception>
- <exception cref="T:System.InvalidOperationException">
- <paramref name="comparer" /> is <see langword="null" />, and one or more elements in <paramref name="keys" /> do not implement the <see cref="T:System.IComparable`1" /> interface.</exception>
- </member>
<member name="M:System.MemoryExtensions.StartsWith(System.ReadOnlySpan{System.Char},System.ReadOnlySpan{System.Char},System.StringComparison)">
<summary>Determines whether a read-only character span begins with a specified value when compared using a specified <see cref="T:System.StringComparison" /> value.</summary>
<param name="span">The source span.</param>
<param name="source">The source span.</param>
<param name="destination">The destination span which contains the transformed characters.</param>
<param name="culture">An object that supplies culture-specific casing rules.</param>
- <exception cref="T:System.InvalidOperationException">The source and destination buffers overlap.</exception>
<returns>The number of characters written into the destination span. If the destination is too small, returns -1.</returns>
+ <exception cref="T:System.InvalidOperationException">The source and destination buffers overlap.</exception>
</member>
<member name="M:System.MemoryExtensions.ToLowerInvariant(System.ReadOnlySpan{System.Char},System.Span{System.Char})">
<summary>Copies the characters from the source span into the destination, converting each character to lowercase, using the casing rules of the invariant culture.</summary>
<param name="source">The source span.</param>
<param name="destination">The destination span which contains the transformed characters.</param>
- <exception cref="T:System.InvalidOperationException">The source and destination buffers overlap.</exception>
<returns>The number of characters written into the destination span. If the destination is too small, returns -1.</returns>
+ <exception cref="T:System.InvalidOperationException">The source and destination buffers overlap.</exception>
</member>
<member name="M:System.MemoryExtensions.ToUpper(System.ReadOnlySpan{System.Char},System.Span{System.Char},System.Globalization.CultureInfo)">
<summary>Copies the characters from the source span into the destination, converting each character to uppercase, using the casing rules of the specified culture.</summary>
<param name="source">The source span.</param>
<param name="destination">The destination span which contains the transformed characters.</param>
<param name="culture">An object that supplies culture-specific casing rules.</param>
- <exception cref="T:System.InvalidOperationException">The source and destination buffers overlap.</exception>
<returns>The number of characters written into the destination span. If the destination is too small, returns -1.</returns>
+ <exception cref="T:System.InvalidOperationException">The source and destination buffers overlap.</exception>
</member>
<member name="M:System.MemoryExtensions.ToUpperInvariant(System.ReadOnlySpan{System.Char},System.Span{System.Char})">
<summary>Copies the characters from the source span into the destination, converting each character to uppercase using the casing rules of the invariant culture.</summary>
<param name="source">The source span.</param>
<param name="destination">The destination span which contains the transformed characters.</param>
- <exception cref="T:System.InvalidOperationException">The source and destination buffers overlap.</exception>
<returns>The number of characters written into the destination span. If the destination is too small, returns -1.</returns>
+ <exception cref="T:System.InvalidOperationException">The source and destination buffers overlap.</exception>
</member>
<member name="M:System.MemoryExtensions.Trim(System.Memory{System.Char})">
<summary>Removes all leading and trailing whitespace characters from a character memory region.</summary>
<typeparam name="T">The type of the elements in the span.</typeparam>
<returns>The trimmed span.</returns>
</member>
- <member name="M:System.MemoryExtensions.TryWrite(System.Span{System.Char},System.IFormatProvider,System.MemoryExtensions.TryWriteInterpolatedStringHandler@,System.Int32@)">
- <summary>Writes the specified interpolated string to the character span.</summary>
- <param name="destination">The span to which the interpolated string should be formatted.</param>
- <param name="provider">An object that supplies culture-specific formatting information.</param>
- <param name="handler">The interpolated string, passed by reference.</param>
- <param name="charsWritten">When this method returns, contains the number of characters written to the span.</param>
- <returns>
- <see langword="true" /> if the entire interpolated string could be formatted successfully; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="M:System.MemoryExtensions.TryWrite(System.Span{System.Char},System.MemoryExtensions.TryWriteInterpolatedStringHandler@,System.Int32@)">
- <summary>Writes the specified interpolated string to the character span.</summary>
- <param name="destination">The span to which the interpolated string should be formatted.</param>
- <param name="handler">The interpolated string, passed by reference.</param>
- <param name="charsWritten">When this method returns, contains the number of characters written to the span.</param>
- <returns>
- <see langword="true" /> if the entire interpolated string could be formatted successfully; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="T:System.MemoryExtensions.TryWriteInterpolatedStringHandler">
- <summary>Provides a handler used by the language compiler to format interpolated strings into character spans.</summary>
- </member>
- <member name="M:System.MemoryExtensions.TryWriteInterpolatedStringHandler.#ctor(System.Int32,System.Int32,System.Span{System.Char},System.Boolean@)">
- <summary>Creates a handler used to write an interpolated string into a span of characterss.</summary>
- <param name="literalLength">The number of constant characters outside of interpolation expressions in the interpolated string.</param>
- <param name="formattedCount">The number of interpolation expressions in the interpolated string.</param>
- <param name="destination">The destination buffer.</param>
- <param name="shouldAppend">Upon return, <see langword="true" /> if the destination may be long enough to support the formatting, or <see langword="false" /> if it won't be.</param>
- </member>
- <member name="M:System.MemoryExtensions.TryWriteInterpolatedStringHandler.#ctor(System.Int32,System.Int32,System.Span{System.Char},System.IFormatProvider,System.Boolean@)">
- <summary>Creates a handler used to write an interpolated string into a span of characters.</summary>
- <param name="literalLength">The number of constant characters outside of interpolation expressions in the interpolated string.</param>
- <param name="formattedCount">The number of interpolation expressions in the interpolated string.</param>
- <param name="destination">The destination buffer.</param>
- <param name="provider" />
- <param name="shouldAppend">Upon return, <see langword="true" /> if the destination may be long enough to support the formatting, or <see langword="false" /> if it won't be.</param>
- </member>
- <member name="M:System.MemoryExtensions.TryWriteInterpolatedStringHandler.AppendFormatted(System.Object,System.Int32,System.String)">
- <summary>Writes the specified value to the handler.</summary>
- <param name="value">The value to write.</param>
- <param name="alignment">The minimum number of characters that should be written for this value. A negative value indicates left-aligned, and the required minimum is the absolute value.</param>
- <param name="format">The format string.</param>
- <returns>
- <see langword="true" /> on success; <see langword="false" /> otherwise.</returns>
- </member>
- <member name="M:System.MemoryExtensions.TryWriteInterpolatedStringHandler.AppendFormatted(System.ReadOnlySpan{System.Char})">
- <summary>Writes the specified value to the handler.</summary>
- <param name="value">The value to write.</param>
- <returns>
- <see langword="false" /> if the operation failed; <see langword="true" /> otherwise.</returns>
- </member>
- <member name="M:System.MemoryExtensions.TryWriteInterpolatedStringHandler.AppendFormatted(System.ReadOnlySpan{System.Char},System.Int32,System.String)">
- <summary>Writes the specified value to the handler.</summary>
- <param name="value">The value to write.</param>
- <param name="alignment">>The minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value.</param>
- <param name="format">The format string.</param>
- <returns>
- <see langword="false" /> if the operation failed; <see langword="true" /> otherwise.</returns>
- </member>
- <member name="M:System.MemoryExtensions.TryWriteInterpolatedStringHandler.AppendFormatted(System.String)">
- <summary>Writes the specified value to the handler.</summary>
- <param name="value">The value to write.</param>
- <returns>
- <see langword="true" /> on success; <see langword="false" /> otherwise.</returns>
- </member>
- <member name="M:System.MemoryExtensions.TryWriteInterpolatedStringHandler.AppendFormatted(System.String,System.Int32,System.String)">
- <summary>Writes a specified value to the handler using a specified format string.</summary>
- <param name="value">The value to write.</param>
- <param name="alignment">The minimum number of characters that should be written for this value. A negative value indicates left-aligned, and the required minimum is the absolute value.</param>
- <param name="format">The format string.</param>
- <returns>
- <see langword="true" /> on success; <see langword="false" /> otherwise.</returns>
- </member>
- <member name="M:System.MemoryExtensions.TryWriteInterpolatedStringHandler.AppendFormatted``1(``0)">
- <summary>Writes the specified value to the handler.</summary>
- <param name="value">The value to write.</param>
- <typeparam name="T">The type of the value to write.</typeparam>
- <returns>
- <see langword="true" /> on success; <see langword="false" /> otherwise.</returns>
- </member>
- <member name="M:System.MemoryExtensions.TryWriteInterpolatedStringHandler.AppendFormatted``1(``0,System.Int32)">
- <summary>Writes the specified value to the handler.</summary>
- <param name="value">The value to write.</param>
- <param name="alignment">The minimum number of characters that should be written for this value.A negative value indicates left-aligned, and the required minimum is the absolute value.</param>
- <typeparam name="T">The type of the value to write.</typeparam>
- <returns>
- <see langword="false" /> if the operation failed; <see langword="true" /> otherwise.</returns>
- </member>
- <member name="M:System.MemoryExtensions.TryWriteInterpolatedStringHandler.AppendFormatted``1(``0,System.Int32,System.String)">
- <summary>Writes a specified value to the handler using a specified format string.</summary>
- <param name="value">The value to write.</param>
- <param name="alignment">The minimum number of characters that should be written for this value. A negative value indicates left-aligned, and the required minimum is the absolute value.</param>
- <param name="format">The format string.</param>
- <typeparam name="T">The type of the value to write.</typeparam>
- <returns>
- <see langword="true" /> on success; <see langword="false" /> otherwise.</returns>
- </member>
- <member name="M:System.MemoryExtensions.TryWriteInterpolatedStringHandler.AppendFormatted``1(``0,System.String)">
- <summary>Writes a specified value to the handler using a specified format string.</summary>
- <param name="value">The value to write.</param>
- <param name="format">The format string.</param>
- <typeparam name="T">The type of the value to write.</typeparam>
- <returns>
- <see langword="true" /> on success; <see langword="false" /> otherwise.</returns>
- </member>
- <member name="M:System.MemoryExtensions.TryWriteInterpolatedStringHandler.AppendLiteral(System.String)">
- <summary>Writes the specified string to the handler.</summary>
- <param name="value">The string to write.</param>
- <returns>
- <see langword="true" /> if the value could be formatted to the span; otherwise, <see langword="false" />.</returns>
- </member>
<member name="T:System.Runtime.InteropServices.MemoryMarshal">
<summary>Provides methods to interoperate with <see cref="T:System.Memory`1" />, <see cref="T:System.ReadOnlyMemory`1" />, <see cref="T:System.Span`1" />, and <see cref="T:System.ReadOnlySpan`1" />.</summary>
</member>
<summary>Casts a <see cref="T:System.ReadOnlySpan`1" /> of one primitive type, <paramref name="T" />, to a <see langword="ReadOnlySpan<Byte>" />.</summary>
<param name="span">The source slice to convert.</param>
<typeparam name="T">The type of items in the read-only span.</typeparam>
+ <returns>A read-only span of type <see cref="T:System.Byte" />.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="T" /> contains references or pointers.</exception>
<exception cref="T:System.OverflowException">The <see cref="P:System.ReadOnlySpan`1.Length" /> property of the new <see cref="T:System.ReadOnlySpan`1" /> would exceed <see cref="F:System.Int32.MaxValue" /></exception>
- <returns>A read-only span of type <see cref="T:System.Byte" />.</returns>
</member>
<member name="M:System.Runtime.InteropServices.MemoryMarshal.AsBytes``1(System.Span{``0})">
<summary>Casts a <see cref="T:System.Span`1" /> of one primitive type, <paramref name="T" />, to a <see langword="Span<Byte>" />.</summary>
<param name="span">The source slice to convert.</param>
<typeparam name="T">The type of items in the span.</typeparam>
+ <returns>A span of type <see cref="T:System.Byte" />.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="T" /> contains references or pointers.</exception>
<exception cref="T:System.OverflowException">The <see cref="P:System.Span`1.Length" /> property of the new <see cref="T:System.Span`1" /> would exceed <see cref="F:System.Int32.MaxValue" /></exception>
- <returns>A span of type <see cref="T:System.Byte" />.</returns>
</member>
<member name="M:System.Runtime.InteropServices.MemoryMarshal.AsMemory``1(System.ReadOnlyMemory{``0})">
<summary>Creates a <see cref="T:System.Memory`1" /> instance from a <see cref="T:System.ReadOnlyMemory`1" />.</summary>
<param name="span">The source slice to convert.</param>
<typeparam name="TFrom">The type of the source span.</typeparam>
<typeparam name="TTo">The type of the target span.</typeparam>
+ <returns>The converted read-only span.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="TFrom" /> or <paramref name="TTo" /> contains references or pointers.</exception>
- <returns>The converted read-only span.</returns>
</member>
<member name="M:System.Runtime.InteropServices.MemoryMarshal.Cast``2(System.Span{``0})">
<summary>Casts a span of one primitive type to a span of another primitive type.</summary>
<param name="span">The source slice to convert.</param>
<typeparam name="TFrom">The type of the source span.</typeparam>
<typeparam name="TTo">The type of the target span.</typeparam>
+ <returns>The converted span.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="TFrom" /> or <paramref name="TTo" /> contains references or pointers.</exception>
- <returns>The converted span.</returns>
</member>
<member name="M:System.Runtime.InteropServices.MemoryMarshal.CreateFromPinnedArray``1(``0[],System.Int32,System.Int32)">
<summary>Creates a new memory buffer over the portion of the pre-pinned target array beginning at the <paramref name="start" /> index and consisting of <paramref name="length" /> items.</summary>
<param name="start">The index of <paramref name="array" /> at which to begin the memory block.</param>
<param name="length">The number of items to include in the memory block.</param>
<typeparam name="T">The type of the array.</typeparam>
+ <returns>A block of memory over the specified elements of <paramref name="array" />. If <paramref name="array" /> is <see langword="null" />, or if <paramref name="start" /> and <paramref name="length" /> are 0, the method returns a <see cref="T:System.Memory`1" /> instance of <see cref="P:System.Memory`1.Length" /> zero.</returns>
<exception cref="T:System.ArrayTypeMismatchException">
<paramref name="array" /> is covariant, and the type of <paramref name="array" /> is not exactly <paramref name="T[]" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="start" /> or the end index is not in the range of 0 to <see cref="P:System.Array.Length" />.</exception>
- <returns>A block of memory over the specified elements of <paramref name="array" />. If <paramref name="array" /> is <see langword="null" />, or if <paramref name="start" /> and <paramref name="length" /> are 0, the method returns a <see cref="T:System.Memory`1" /> instance of <see cref="P:System.Memory`1.Length" /> zero.</returns>
</member>
<member name="M:System.Runtime.InteropServices.MemoryMarshal.CreateReadOnlySpan``1(``0@,System.Int32)">
<summary>Creates a new read-only span over a portion of a regular managed object.</summary>
<typeparam name="T">The type of the data items.</typeparam>
<returns>A read-only span.</returns>
</member>
- <member name="M:System.Runtime.InteropServices.MemoryMarshal.CreateReadOnlySpanFromNullTerminated(System.Byte*)">
- <summary>Creates a new read-only span for a null-terminated UTF8 string.</summary>
- <param name="value">The pointer to the null-terminated string of bytes.</param>
- <exception cref="T:System.ArgumentException">The string is longer than <see cref="F:System.Int32.MaxValue" />.</exception>
- <returns>A read-only span representing the specified null-terminated string, or an empty span if the pointer is <see langword="null" />.</returns>
- </member>
- <member name="M:System.Runtime.InteropServices.MemoryMarshal.CreateReadOnlySpanFromNullTerminated(System.Char*)">
- <summary>Creates a new read-only span for a null-terminated string.</summary>
- <param name="value">The pointer to the null-terminated string of characters.</param>
- <exception cref="T:System.ArgumentException">The string is longer than <see cref="F:System.Int32.MaxValue" />.</exception>
- <returns>A read-only span representing the specified null-terminated string, or an empty span if the pointer is <see langword="null" />.</returns>
- </member>
<member name="M:System.Runtime.InteropServices.MemoryMarshal.CreateSpan``1(``0@,System.Int32)">
<summary>Creates a new span over a portion of a regular managed object.</summary>
<param name="reference">A reference to data.</param>
<typeparam name="T">The type of the data items.</typeparam>
<returns>A span.</returns>
</member>
- <member name="M:System.Runtime.InteropServices.MemoryMarshal.GetArrayDataReference(System.Array)">
- <summary>Returns a reference to the 0th element of <paramref name="array" />. If the array is empty, returns a reference to where the 0th element would have been stored. Such a reference may be used for pinning but must never be dereferenced.</summary>
- <param name="array">The array to analyze.</param>
- <exception cref="T:System.NullReferenceException">
- <paramref name="array" /> is <see langword="null" />.</exception>
- <returns>A reference to the 0th element of <paramref name="array" />.</returns>
- </member>
- <member name="M:System.Runtime.InteropServices.MemoryMarshal.GetArrayDataReference``1(``0[])">
- <summary>Returns a reference to the 0th element of <paramref name="array" />. If the array is empty, returns a reference to where the 0th element would have been stored. Such a reference may be used for pinning but must never be dereferenced.</summary>
- <param name="array">The array to analyze.</param>
- <typeparam name="T">The type of the array elements.</typeparam>
- <exception cref="T:System.NullReferenceException">
- <paramref name="array" /> is <see langword="null" />.</exception>
- <returns>Reference to the 0th element in <paramref name="array" />.</returns>
- </member>
<member name="M:System.Runtime.InteropServices.MemoryMarshal.GetReference``1(System.ReadOnlySpan{``0})">
<summary>Returns a reference to the element of the read-only span at index 0.</summary>
<param name="span">The read-only span from which the reference is retrieved.</param>
<returns>A reference to the element at index 0.</returns>
</member>
<member name="M:System.Runtime.InteropServices.MemoryMarshal.Read``1(System.ReadOnlySpan{System.Byte})">
- <summary>Reads a structure of type <typeparamref name="T" /> out of a read-only span of bytes.</summary>
+ <summary>Reads a structure of type <param name="T" /> out of a read-only span of bytes.</summary>
<param name="source">A read-only span.</param>
<typeparam name="T">The type of the item to retrieve from the read-only span.</typeparam>
+ <returns>The structure retrieved from the read-only span.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="T" /> contains references or pointers.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="source" /> is smaller than <paramref name="T" />.</exception>
- <returns>The structure retrieved from the read-only span.</returns>
</member>
<member name="M:System.Runtime.InteropServices.MemoryMarshal.ToEnumerable``1(System.ReadOnlyMemory{``0})">
<summary>Creates an <see cref="T:System.Collections.Generic.IEnumerable`1" /> view of the given read-only memory buffer.</summary>
<param name="source">A read-only span of bytes.</param>
<param name="value">When the method returns, an instance of <paramref name="T" />.</param>
<typeparam name="T">The type of the structure to retrieve.</typeparam>
- <exception cref="T:System.ArgumentException">
- <paramref name="T" /> contains references or pointers.</exception>
<returns>
<see langword="true" /> if the method succeeds in retrieving an instance of the structure; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.ArgumentException">
+ <paramref name="T" /> contains references or pointers.</exception>
</member>
<member name="M:System.Runtime.InteropServices.MemoryMarshal.TryWrite``1(System.Span{System.Byte},``0@)">
<summary>Tries to write a structure of type <paramref name="T" /> into a span of bytes.</summary>
<param name="destination">The span of bytes to contain the structure.</param>
<param name="value">The structure to be written to the span.</param>
<typeparam name="T">The type of the structure.</typeparam>
- <exception cref="T:System.ArgumentException">
- <paramref name="T" /> contains references or pointers.</exception>
<returns>
<see langword="true" /> if the write operation succeeded; otherwise, <see langword="false" />. The method returns <see langword="false" /> if the span is too small to contain <paramref name="T" />.</returns>
+ <exception cref="T:System.ArgumentException">
+ <paramref name="T" /> contains references or pointers.</exception>
</member>
<member name="M:System.Runtime.InteropServices.MemoryMarshal.Write``1(System.Span{System.Byte},``0@)">
<summary>Writes a structure of type <paramref name="T" /> into a span of bytes.</summary>
<summary>Returns the object part of this <see cref="T:System.SequencePosition" />.</summary>
<returns>The object part of this sequence position.</returns>
</member>
- <member name="T:System.Text.EncodingExtensions">
- <summary>Provides extension methods for the encoding types, such as <see cref="T:System.Text.Encoding" />, <see cref="T:System.Text.Encoder" />, and <see cref="T:System.Text.Decoder" />.</summary>
- </member>
- <member name="M:System.Text.EncodingExtensions.Convert(System.Text.Decoder,System.Buffers.ReadOnlySequence{System.Byte}@,System.Buffers.IBufferWriter{System.Char},System.Boolean,System.Int64@,System.Boolean@)">
- <summary>Converts a <see cref="T:System.Buffers.ReadOnlySequence`1" /> to UTF-16 encoded characters and writes the result to <paramref name="writer" />.</summary>
- <param name="decoder">The decoder instance that can convert bytes to <see langword="char" /> values.</param>
- <param name="bytes">A sequence of bytes to decode.</param>
- <param name="writer">The buffer to which the decoded characters will be written.</param>
- <param name="flush">
- <see langword="true" /> to indicate no further data is to be converted; otherwise <see langword="false" />.</param>
- <param name="charsUsed">When this method returns, contains the count of characters that were written to <paramref name="writer" />.</param>
- <param name="completed">When this method returns, contains <see langword="true" /> if <paramref name="decoder" /> contains no partial internal state; otherwise, <see langword="false" />.
- If <paramref name="flush" /> is <see langword="true" />, this will always be set to <see langword="true" /> when the method returns.</param>
- <exception cref="T:System.Text.DecoderFallbackException">
- <paramref name="bytes" /> contains data that cannot be decoded and <paramref name="decoder" /> is configured to throw when such data is seen.</exception>
- </member>
- <member name="M:System.Text.EncodingExtensions.Convert(System.Text.Decoder,System.ReadOnlySpan{System.Byte},System.Buffers.IBufferWriter{System.Char},System.Boolean,System.Int64@,System.Boolean@)">
- <summary>Converts a <see cref="T:System.ReadOnlySpan`1" /> to chars using <paramref name="decoder" /> and writes the result to <paramref name="writer" />.</summary>
- <param name="decoder">The decoder instance that can convert bytes to <see langword="char" /> values.</param>
- <param name="bytes">A sequence of bytes to decode.</param>
- <param name="writer">The buffer to which the decoded chars will be written.</param>
- <param name="flush">
- <see langword="true" /> to indicate no further data is to be converted; otherwise <see langword="false" />.</param>
- <param name="charsUsed">When this method returns, contains the count of <see langword="char" />s which were written to <paramref name="writer" />.</param>
- <param name="completed">When this method returns, contains <see langword="true" /> if <paramref name="decoder" /> contains no partial internal state; otherwise, <see langword="false" />.
- If <paramref name="flush" /> is <see langword="true" />, this will always be set to <see langword="true" /> when the method returns.</param>
- <exception cref="T:System.Text.DecoderFallbackException">
- <paramref name="bytes" /> contains data that cannot be encoded and <paramref name="decoder" /> is configured to throw when such data is seen.</exception>
- </member>
- <member name="M:System.Text.EncodingExtensions.Convert(System.Text.Encoder,System.Buffers.ReadOnlySequence{System.Char}@,System.Buffers.IBufferWriter{System.Byte},System.Boolean,System.Int64@,System.Boolean@)">
- <summary>Converts a <see cref="T:System.Buffers.ReadOnlySequence`1" /> to encoded bytes and writes the result to <paramref name="writer" />.</summary>
- <param name="encoder">The encoder instance that can convert <see langword="char" /> values to bytes.</param>
- <param name="chars">A sequence of characters to encode.</param>
- <param name="writer">The buffer to which the encoded bytes will be written.</param>
- <param name="flush">
- <see langword="true" /> to indicate no further data is to be converted; otherwise <see langword="false" />.</param>
- <param name="bytesUsed">When this method returns, contains the count of <see langword="byte" />s which were written to <paramref name="writer" />.</param>
- <param name="completed">When this method returns, contains <see langword="true" /> if all input up until <paramref name="bytesUsed" /> was converted; otherwise, <see langword="false" />. If <paramref name="flush" /> is <see langword="true" />, this will always be set to <see langword="true" /> when the method returns.</param>
- <exception cref="T:System.Text.EncoderFallbackException">
- <paramref name="chars" /> contains data that cannot be encoded and <paramref name="encoder" /> is configured to throw when such data is seen.</exception>
- </member>
- <member name="M:System.Text.EncodingExtensions.Convert(System.Text.Encoder,System.ReadOnlySpan{System.Char},System.Buffers.IBufferWriter{System.Byte},System.Boolean,System.Int64@,System.Boolean@)">
- <summary>Converts a <see cref="T:System.ReadOnlySpan`1" /> to bytes using <paramref name="encoder" /> and writes the result to <paramref name="writer" />.</summary>
- <param name="encoder">The encoder instance that can convert <see langword="char" /> values to bytes.</param>
- <param name="chars">A sequence of characters to encode.</param>
- <param name="writer">The buffer to which the encoded bytes will be written.</param>
- <param name="flush">
- <see langword="true" /> to indicate no further data is to be converted; otherwise <see langword="false" />.</param>
- <param name="bytesUsed">When this method returns, contains the count of <see langword="byte" />s which were written to <paramref name="writer" />.</param>
- <param name="completed">When this method returns, contains <see langword="true" /> if <paramref name="encoder" /> contains no partial internal state; otherwise, <see langword="false" />.
- If <paramref name="flush" /> is <see langword="true" />, this will always be set to <see langword="true" /> when the method returns.</param>
- <exception cref="T:System.Text.EncoderFallbackException">
- <paramref name="chars" /> contains data that cannot be encoded and <paramref name="encoder" /> is configured to throw when such data is seen.</exception>
- </member>
- <member name="M:System.Text.EncodingExtensions.GetBytes(System.Text.Encoding,System.Buffers.ReadOnlySequence{System.Char}@)">
- <summary>Encodes the specified <see cref="T:System.Buffers.ReadOnlySequence`1" /> into a <see cref="T:System.Byte" /> array using the specified <see cref="T:System.Text.Encoding" />.</summary>
- <param name="encoding">The encoding that represents how the data in <paramref name="chars" /> should be encoded.</param>
- <param name="chars">The sequence to encode to bytes.</param>
- <exception cref="T:System.Text.EncoderFallbackException">
- <paramref name="chars" /> contains data that cannot be encoded and <paramref name="encoding" /> is configured to throw when such data is seen.</exception>
- <returns>A <see cref="T:System.Byte" /> array that represents the encoded contents of <paramref name="chars" />.</returns>
- </member>
- <member name="M:System.Text.EncodingExtensions.GetBytes(System.Text.Encoding,System.Buffers.ReadOnlySequence{System.Char}@,System.Buffers.IBufferWriter{System.Byte})">
- <summary>Decodes the specified <see cref="T:System.Buffers.ReadOnlySequence`1" /> to <see langword="byte" />s using the specified <see cref="T:System.Text.Encoding" /> and writes the result to <paramref name="writer" />.</summary>
- <param name="encoding">The encoding that represents how the data in <paramref name="chars" /> should be encoded.</param>
- <param name="chars">The <see cref="T:System.Buffers.ReadOnlySequence`1" /> whose contents should be encoded.</param>
- <param name="writer">The buffer to which the encoded bytes will be written.</param>
- <exception cref="T:System.Text.EncoderFallbackException">
- <paramref name="chars" /> contains data that cannot be encoded and <paramref name="encoding" /> is configured to throw when such data is seen.</exception>
- <returns>The number of bytes written to <paramref name="writer" />.</returns>
- </member>
- <member name="M:System.Text.EncodingExtensions.GetBytes(System.Text.Encoding,System.Buffers.ReadOnlySequence{System.Char}@,System.Span{System.Byte})">
- <summary>Encodes the specified <see cref="T:System.Buffers.ReadOnlySequence`1" /> to <see langword="byte" />s using the specified <see cref="T:System.Text.Encoding" /> and outputs the result to <paramref name="bytes" />.</summary>
- <param name="encoding">The encoding that represents how the data in <paramref name="chars" /> should be encoded.</param>
- <param name="chars">The sequence to encode to bytes.</param>
- <param name="bytes">The destination buffer to which the encoded bytes will be written.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="bytes" /> is not large enough to contain the encoded form of <paramref name="chars" />.</exception>
- <exception cref="T:System.Text.EncoderFallbackException">
- <paramref name="chars" /> contains data that cannot be encoded and <paramref name="encoding" /> is configured to throw when such data is seen.</exception>
- <returns>The number of bytes written to <paramref name="bytes" />.</returns>
- </member>
- <member name="M:System.Text.EncodingExtensions.GetBytes(System.Text.Encoding,System.ReadOnlySpan{System.Char},System.Buffers.IBufferWriter{System.Byte})">
- <summary>Encodes the specified <see cref="T:System.ReadOnlySpan`1" /> to <see langword="byte" />s using the specified <see cref="T:System.Text.Encoding" /> and writes the result to <paramref name="writer" />.</summary>
- <param name="encoding">The encoding that represents how the data in <paramref name="chars" /> should be encoded.</param>
- <param name="chars">The sequence to encode to bytes.</param>
- <param name="writer">The buffer to which the encoded bytes will be written.</param>
- <exception cref="T:System.Text.EncoderFallbackException">
- <paramref name="chars" /> contains data that cannot be encoded and <paramref name="encoding" /> is configured to throw when such data is seen.</exception>
- <returns>The number of bytes written to <paramref name="writer" />.</returns>
- </member>
- <member name="M:System.Text.EncodingExtensions.GetChars(System.Text.Encoding,System.Buffers.ReadOnlySequence{System.Byte}@,System.Buffers.IBufferWriter{System.Char})">
- <summary>Decodes the specified <see cref="T:System.Buffers.ReadOnlySequence`1" /> to <see langword="char" />s using the specified <see cref="T:System.Text.Encoding" /> and writes the result to <paramref name="writer" />.</summary>
- <param name="encoding">The encoding that represents how the data in <paramref name="bytes" /> should be decoded.</param>
- <param name="bytes">The sequence whose bytes should be decoded.</param>
- <param name="writer">The buffer to which the decoded chars will be written.</param>
- <exception cref="T:System.Text.DecoderFallbackException">
- <paramref name="bytes" /> contains data that cannot be decoded and <paramref name="encoding" /> is configured to throw when such data is seen.</exception>
- <returns>The number of chars written to <paramref name="writer" />.</returns>
- </member>
- <member name="M:System.Text.EncodingExtensions.GetChars(System.Text.Encoding,System.Buffers.ReadOnlySequence{System.Byte}@,System.Span{System.Char})">
- <summary>Decodes the specified <see cref="T:System.Buffers.ReadOnlySequence`1" /> to <see langword="char" />s using the specified <see cref="T:System.Text.Encoding" /> and outputs the result to <paramref name="chars" />.</summary>
- <param name="encoding">The encoding that represents how the data in <paramref name="bytes" /> is encoded.</param>
- <param name="bytes">The sequence to decode to characters.</param>
- <param name="chars">The destination buffer to which the decoded characters will be written.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="chars" /> is not large enough to contain the encoded form of <paramref name="bytes" />.</exception>
- <exception cref="T:System.Text.DecoderFallbackException">
- <paramref name="bytes" /> contains data that cannot be decoded and <paramref name="encoding" /> is configured to throw when such data is seen.</exception>
- <returns>The number of chars written to <paramref name="chars" />.</returns>
- </member>
- <member name="M:System.Text.EncodingExtensions.GetChars(System.Text.Encoding,System.ReadOnlySpan{System.Byte},System.Buffers.IBufferWriter{System.Char})">
- <summary>Decodes the specified <see cref="T:System.ReadOnlySpan`1" /> to <see langword="char" />s using the specified <see cref="T:System.Text.Encoding" /> and writes the result to <paramref name="writer" />.</summary>
- <param name="encoding">The encoding that represents how the data in <paramref name="bytes" /> should be decoded.</param>
- <param name="bytes">The span of bytes to decode.</param>
- <param name="writer">The buffer to which the decoded chars will be written.</param>
- <exception cref="T:System.Text.DecoderFallbackException">
- <paramref name="bytes" /> contains data that cannot be decoded and <paramref name="encoding" /> is configured to throw when such data is seen.</exception>
- <returns>The number of chars written to <paramref name="writer" />.</returns>
- </member>
- <member name="M:System.Text.EncodingExtensions.GetString(System.Text.Encoding,System.Buffers.ReadOnlySequence{System.Byte}@)">
- <summary>Decodes the specified <see cref="T:System.Buffers.ReadOnlySequence`1" /> into a <see cref="T:System.String" /> using the specified <see cref="T:System.Text.Encoding" />.</summary>
- <param name="encoding">The encoding that represents how the data in <paramref name="bytes" /> is encoded.</param>
- <param name="bytes">The sequence to decode into characters.</param>
- <exception cref="T:System.Text.DecoderFallbackException">
- <paramref name="bytes" /> contains data that cannot be decoded and <paramref name="encoding" /> is configured to throw when such data is seen.</exception>
- <returns>A <see cref="T:System.String" /> which represents the decoded contents of <paramref name="bytes" />.</returns>
- </member>
- <member name="T:System.Text.SpanLineEnumerator">
- <summary>Enumerates the lines of a <see cref="T:System.ReadOnlySpan`1" />.</summary>
- </member>
- <member name="M:System.Text.SpanLineEnumerator.GetEnumerator">
- <summary>Returns this instance as an enumerator.</summary>
- <returns>This instance as an enumerator.</returns>
- </member>
- <member name="M:System.Text.SpanLineEnumerator.MoveNext">
- <summary>Advances the enumerator to the next line of the span.</summary>
- <returns>
- <see langword="true" /> if the enumerator successfully advanced to the next line; <see langword="false" /> if the enumerator has advanced past the end of the span.</returns>
- </member>
- <member name="P:System.Text.SpanLineEnumerator.Current">
- <summary>Gets the line at the current position of the enumerator.</summary>
- <returns>The line at the current position of the enumerator.</returns>
- </member>
<member name="T:System.Text.SpanRuneEnumerator">
<summary>Provides an enumerator for the <see cref="T:System.Text.Rune" /> values represented by a span containing UTF-16 text.</summary>
</member>
+ <member name="P:System.Text.SpanRuneEnumerator.Current">
+ <summary>Gets the <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</summary>
+ <returns>The <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</returns>
+ </member>
<member name="M:System.Text.SpanRuneEnumerator.GetEnumerator">
<summary>Returns the current enumerator instance.</summary>
<returns>The current enumerator instance.</returns>
<returns>
<see langword="true" /> if the enumerator successfully advanced to the next item; <see langword="false" /> if the end of the span has been reached.</returns>
</member>
- <member name="P:System.Text.SpanRuneEnumerator.Current">
- <summary>Gets the <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</summary>
- <returns>The <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</returns>
- </member>
</members>
</doc>
\ No newline at end of file
projects / platform / core / csapi / tizenfx.git / blobdiff