<Type Name="Rune" FullName="System.Text.Rune">

<TypeSignature Language="C#" Value="public readonly struct Rune : IComparable, IComparable&lt;System.Text.Rune&gt;, IEquatable&lt;System.Text.Rune&gt;, ISpanFormattable, IUtf8SpanFormattable, IUtf8SpanParsable&lt;System.Text.Rune&gt;" FrameworkAlternate="net-10.0;net-11.0" />

<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit Rune extends System.ValueType implements class System.IComparable, class System.IComparable`1&lt;valuetype System.Text.Rune&gt;, class System.IEquatable`1&lt;valuetype System.Text.Rune&gt;, class System.IFormattable, class System.ISpanFormattable, class System.IUtf8SpanFormattable, class System.IUtf8SpanParsable`1&lt;valuetype System.Text.Rune&gt;" FrameworkAlternate="net-10.0;net-11.0" />

<TypeSignature Language="DocId" Value="T:System.Text.Rune" />

<TypeSignature Language="VB.NET" Value="Public Structure Rune&#xA;Implements IComparable, IComparable(Of Rune), IEquatable(Of Rune), ISpanFormattable, IUtf8SpanFormattable, IUtf8SpanParsable(Of Rune)" FrameworkAlternate="net-10.0;net-11.0" />

<TypeSignature Language="F#" Value="type Rune = struct&#xA; interface IFormattable&#xA; interface ISpanFormattable&#xA; interface IUtf8SpanFormattable&#xA; interface IUtf8SpanParsable&lt;Rune&gt;" FrameworkAlternate="net-10.0;net-11.0" />

<TypeSignature Language="C++ CLI" Value="public value class Rune : IComparable, IComparable&lt;System::Text::Rune&gt;, IEquatable&lt;System::Text::Rune&gt;, ISpanFormattable, IUtf8SpanFormattable, IUtf8SpanParsable&lt;System::Text::Rune&gt;" FrameworkAlternate="net-10.0;net-11.0" />

<TypeSignature Language="C#" Value="public readonly struct Rune : IComparable, IComparable&lt;System.Text.Rune&gt;, IEquatable&lt;System.Text.Rune&gt;" FrameworkAlternate="net-5.0" />

<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit Rune extends System.ValueType implements class System.IComparable, class System.IComparable`1&lt;valuetype System.Text.Rune&gt;, class System.IEquatable`1&lt;valuetype System.Text.Rune&gt;" FrameworkAlternate="net-5.0" />

<TypeSignature Language="VB.NET" Value="Public Structure Rune&#xA;Implements IComparable, IComparable(Of Rune), IEquatable(Of Rune)" FrameworkAlternate="net-5.0" />

<TypeSignature Language="F#" Value="type Rune = struct" FrameworkAlternate="net-5.0;netcore-3.0;netcore-3.1" />

<TypeSignature Language="C++ CLI" Value="public value class Rune : IComparable, IComparable&lt;System::Text::Rune&gt;, IEquatable&lt;System::Text::Rune&gt;" FrameworkAlternate="net-5.0" />

<TypeSignature Language="C#" Value="public readonly struct Rune : IComparable, IComparable&lt;System.Text.Rune&gt;, IEquatable&lt;System.Text.Rune&gt;, ISpanFormattable" FrameworkAlternate="net-6.0;net-7.0" />

<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit Rune extends System.ValueType implements class System.IComparable, class System.IComparable`1&lt;valuetype System.Text.Rune&gt;, class System.IEquatable`1&lt;valuetype System.Text.Rune&gt;, class System.IFormattable, class System.ISpanFormattable" FrameworkAlternate="net-6.0;net-7.0" />

<TypeSignature Language="VB.NET" Value="Public Structure Rune&#xA;Implements IComparable, IComparable(Of Rune), IEquatable(Of Rune), ISpanFormattable" FrameworkAlternate="net-6.0;net-7.0" />

<TypeSignature Language="F#" Value="type Rune = struct&#xA; interface ISpanFormattable&#xA; interface IFormattable" FrameworkAlternate="net-6.0" />

<TypeSignature Language="C++ CLI" Value="public value class Rune : IComparable, IComparable&lt;System::Text::Rune&gt;, IEquatable&lt;System::Text::Rune&gt;, ISpanFormattable" FrameworkAlternate="net-6.0;net-7.0" />

<TypeSignature Language="F#" Value="type Rune = struct&#xA; interface IFormattable&#xA; interface ISpanFormattable" FrameworkAlternate="net-7.0" />

<TypeSignature Language="C#" Value="public readonly struct Rune : IComparable, IComparable&lt;System.Text.Rune&gt;, IEquatable&lt;System.Text.Rune&gt;, ISpanFormattable, IUtf8SpanFormattable" FrameworkAlternate="net-8.0;net-9.0" />

<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit Rune extends System.ValueType implements class System.IComparable, class System.IComparable`1&lt;valuetype System.Text.Rune&gt;, class System.IEquatable`1&lt;valuetype System.Text.Rune&gt;, class System.IFormattable, class System.ISpanFormattable, class System.IUtf8SpanFormattable" FrameworkAlternate="net-8.0;net-9.0" />

<TypeSignature Language="VB.NET" Value="Public Structure Rune&#xA;Implements IComparable, IComparable(Of Rune), IEquatable(Of Rune), ISpanFormattable, IUtf8SpanFormattable" FrameworkAlternate="net-8.0;net-9.0" />

<TypeSignature Language="F#" Value="type Rune = struct&#xA; interface IFormattable&#xA; interface ISpanFormattable&#xA; interface IUtf8SpanFormattable" FrameworkAlternate="net-8.0;net-9.0" />

<TypeSignature Language="C++ CLI" Value="public value class Rune : IComparable, IComparable&lt;System::Text::Rune&gt;, IEquatable&lt;System::Text::Rune&gt;, ISpanFormattable, IUtf8SpanFormattable" FrameworkAlternate="net-8.0;net-9.0" />

<TypeSignature Language="C#" Value="public readonly struct Rune : IComparable&lt;System.Text.Rune&gt;, IEquatable&lt;System.Text.Rune&gt;" FrameworkAlternate="netcore-3.0;netcore-3.1" />

<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit Rune extends System.ValueType implements class System.IComparable`1&lt;valuetype System.Text.Rune&gt;, class System.IEquatable`1&lt;valuetype System.Text.Rune&gt;" FrameworkAlternate="netcore-3.0;netcore-3.1" />

<TypeSignature Language="VB.NET" Value="Public Structure Rune&#xA;Implements IComparable(Of Rune), IEquatable(Of Rune)" FrameworkAlternate="netcore-3.0;netcore-3.1" />

<TypeSignature Language="C++ CLI" Value="public value class Rune : IComparable&lt;System::Text::Rune&gt;, IEquatable&lt;System::Text::Rune&gt;" FrameworkAlternate="netcore-3.0;netcore-3.1" />

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<Base>

<BaseTypeName>System.ValueType</BaseTypeName>

</Base>

<Interfaces>

<Interface FrameworkAlternate="net-10.0;net-11.0;net-5.0;net-6.0;net-7.0;net-8.0;net-9.0">

<InterfaceName>System.IComparable</InterfaceName>

</Interface>

<Interface>

<InterfaceName>System.IComparable&lt;System.Text.Rune&gt;</InterfaceName>

</Interface>

<Interface>

<InterfaceName>System.IEquatable&lt;System.Text.Rune&gt;</InterfaceName>

</Interface>

<Interface FrameworkAlternate="net-10.0;net-11.0;net-6.0;net-7.0;net-8.0;net-9.0">

<InterfaceName>System.IFormattable</InterfaceName>

</Interface>

<Interface FrameworkAlternate="net-10.0;net-11.0;net-6.0;net-7.0;net-8.0;net-9.0">

<InterfaceName>System.ISpanFormattable</InterfaceName>

</Interface>

<Interface FrameworkAlternate="net-10.0;net-11.0;net-8.0;net-9.0">

<InterfaceName>System.IUtf8SpanFormattable</InterfaceName>

</Interface>

<Interface FrameworkAlternate="net-10.0;net-11.0">

<InterfaceName>System.IUtf8SpanParsable&lt;System.Text.Rune&gt;</InterfaceName>

</Interface>

</Interfaces>

<Attributes>

<Attribute>

<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>

<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.IsReadOnly&gt;]</AttributeName>

</Attribute>

</Attributes>

<Docs>

<summary>Represents a Unicode scalar value ([ U+0000..U+D7FF ], inclusive; or [ U+E000..U+10FFFF ], inclusive).</summary>

<remarks>For more information about this API, see <see href="/dotnet/fundamentals/runtime-libraries/system-text-rune">Supplemental API remarks for Rune</see>.</remarks>

</Docs>

<Members>

<Member MemberName=".ctor">

<MemberSignature Language="C#" Value="public Rune (char ch);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(char ch) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.#ctor(System.Char)" />

<MemberSignature Language="VB.NET" Value="Public Sub New (ch As Char)" />

<MemberSignature Language="F#" Value="new System.Text.Rune : char -&gt; System.Text.Rune" Usage="new System.Text.Rune ch" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; Rune(char ch);" />

<MemberType>Constructor</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<Parameters>

<Parameter Name="ch" Type="System.Char" />

</Parameters>

<Docs>

<param name="ch">A UTF-16 code unit.</param>

<summary>Creates a <see cref="T:System.Text.Rune" /> from the provided UTF-16 code unit.</summary>

<remarks>To be added.</remarks>

<exception cref="T:System.ArgumentOutOfRangeException">

<paramref name="ch" /> represents a UTF-16 surrogate code point (U+D800..U+DFFF, inclusive).</exception>

</Docs>

</Member>

<Member MemberName=".ctor">

<MemberSignature Language="C#" Value="public Rune (int value);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 value) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.#ctor(System.Int32)" />

<MemberSignature Language="VB.NET" Value="Public Sub New (value As Integer)" />

<MemberSignature Language="F#" Value="new System.Text.Rune : int -&gt; System.Text.Rune" Usage="new System.Text.Rune value" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; Rune(int value);" />

<MemberType>Constructor</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<Parameters>

<Parameter Name="value" Type="System.Int32" />

</Parameters>

<Docs>

<param name="value">A Unicode scalar value.</param>

<summary>Creates a <see cref="T:System.Text.Rune" /> from the specified 32-bit integer that represents a Unicode scalar value.</summary>

<remarks>To be added.</remarks>

<exception cref="T:System.ArgumentOutOfRangeException">

<paramref name="value" /> does not represent a Unicode scalar value.</exception>

</Docs>

</Member>

<Member MemberName=".ctor">

<MemberSignature Language="C#" Value="public Rune (uint value);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int32 value) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.#ctor(System.UInt32)" />

<MemberSignature Language="VB.NET" Value="Public Sub New (value As UInteger)" />

<MemberSignature Language="F#" Value="new System.Text.Rune : uint32 -&gt; System.Text.Rune" Usage="new System.Text.Rune value" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; Rune(System::UInt32 value);" />

<MemberType>Constructor</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<Attributes>

<Attribute>

<AttributeName Language="C#">[System.CLSCompliant(false)]</AttributeName>

<AttributeName Language="F#">[&lt;System.CLSCompliant(false)&gt;]</AttributeName>

</Attribute>

</Attributes>

<Parameters>

<Parameter Name="value" Type="System.UInt32" />

</Parameters>

<Docs>

<param name="value">A Unicode scalar value.</param>

<summary>Creates a <see cref="T:System.Text.Rune" /> from the specified 32-bit unsigned integer that represents a Unicode scalar value.</summary>

<remarks>To be added.</remarks>

<exception cref="T:System.ArgumentOutOfRangeException">

<paramref name="value" /> does not represent a Unicode scalar value.</exception>

</Docs>

</Member>

<Member MemberName=".ctor">

<MemberSignature Language="C#" Value="public Rune (char highSurrogate, char lowSurrogate);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(char highSurrogate, char lowSurrogate) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.#ctor(System.Char,System.Char)" />

<MemberSignature Language="VB.NET" Value="Public Sub New (highSurrogate As Char, lowSurrogate As Char)" />

<MemberSignature Language="F#" Value="new System.Text.Rune : char * char -&gt; System.Text.Rune" Usage="new System.Text.Rune (highSurrogate, lowSurrogate)" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; Rune(char highSurrogate, char lowSurrogate);" />

<MemberType>Constructor</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<Parameters>

<Parameter Name="highSurrogate" Type="System.Char" />

<Parameter Name="lowSurrogate" Type="System.Char" />

</Parameters>

<Docs>

<param name="highSurrogate">The high surrogate of the surrogate pair.</param>

<param name="lowSurrogate">The low surrogate of the surrogate pair.</param>

<summary>Creates a <see cref="T:System.Text.Rune" /> from the provided UTF-16 surrogate pair.</summary>

<remarks>To be added.</remarks>

<exception cref="T:System.ArgumentOutOfRangeException">

<paramref name="highSurrogate" /> does not represent a UTF-16 high surrogate code point.

-or-

<paramref name="lowSurrogate" /> does not represent a UTF-16 low surrogate code point.</exception>

</Docs>

</Member>

<Member MemberName="CompareTo">

<MemberSignature Language="C#" Value="public int CompareTo (System.Text.Rune other);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 CompareTo(valuetype System.Text.Rune other) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.CompareTo(System.Text.Rune)" />

<MemberSignature Language="VB.NET" Value="Public Function CompareTo (other As Rune) As Integer" />

<MemberSignature Language="F#" Value="abstract member CompareTo : System.Text.Rune -&gt; int&#xA;override this.CompareTo : System.Text.Rune -&gt; int" Usage="rune.CompareTo other" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual int CompareTo(System::Text::Rune other);" />

<MemberType>Method</MemberType>

<Implements>

<InterfaceMember>M:System.IComparable`1.CompareTo(`0)</InterfaceMember>

</Implements>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Int32</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="other" Type="System.Text.Rune" />

</Parameters>

<Docs>

<param name="other">The instance to compare with the current instance.</param>

<summary>Compares the current instance to the specified <see cref="T:System.Text.Rune" /> instance.</summary>

<returns>A signed integer indicating the position of this instance in the sort order in relation to <paramref name="other" />: <br />- Less than zero: This instance precedes <paramref name="other" />.

<br />- Zero: The instance has the same position in the sort order as <paramref name="other" />.

<br />- Greater than zero: This instance follows <paramref name="other" />.</returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="DecodeFromUtf16">

<MemberSignature Language="C#" Value="public static System.Buffers.OperationStatus DecodeFromUtf16 (ReadOnlySpan&lt;char&gt; source, out System.Text.Rune result, out int charsConsumed);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Buffers.OperationStatus DecodeFromUtf16(valuetype System.ReadOnlySpan`1&lt;char&gt; source, [out] valuetype System.Text.Rune&amp; result, [out] int32&amp; charsConsumed) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.DecodeFromUtf16(System.ReadOnlySpan{System.Char},System.Text.Rune@,System.Int32@)" />

<MemberSignature Language="VB.NET" Value="Public Shared Function DecodeFromUtf16 (source As ReadOnlySpan(Of Char), ByRef result As Rune, ByRef charsConsumed As Integer) As OperationStatus" />

<MemberSignature Language="F#" Value="static member DecodeFromUtf16 : ReadOnlySpan&lt;char&gt; * Rune * int -&gt; System.Buffers.OperationStatus" Usage="System.Text.Rune.DecodeFromUtf16 (source, result, charsConsumed)" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; static System::Buffers::OperationStatus DecodeFromUtf16(ReadOnlySpan&lt;char&gt; source, [Runtime::InteropServices::Out] System::Text::Rune % result, [Runtime::InteropServices::Out] int % charsConsumed);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Buffers.OperationStatus</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="source" Type="System.ReadOnlySpan&lt;System.Char&gt;" />

<Parameter Name="result" Type="System.Text.Rune" RefType="out" />

<Parameter Name="charsConsumed" Type="System.Int32" RefType="out" />

</Parameters>

<Docs>

<param name="source">A read-only UTF-16 character span.</param>

<param name="result">When this method returns, the decoded rune.</param>

<param name="charsConsumed">When this method returns, the number of characters read to create the rune.</param>

<summary>Decodes the <see cref="T:System.Text.Rune" /> at the beginning of the provided UTF-16 source buffer.</summary>

<returns>

<see cref="F:System.Buffers.OperationStatus.Done" /> if the source buffer begins with a valid UTF-16 encoded scalar value. <paramref name="result" /> then contains the decoded <see cref="T:System.Text.Rune" />, and <paramref name="charsConsumed" /> contains the number of <see cref="T:System.Char" /> values used in the input buffer to encode the <see cref="T:System.Text.Rune" />.

<see cref="F:System.Buffers.OperationStatus.NeedMoreData" /> if the source buffer is empty or contains only a standalone UTF-16 high surrogate character. <paramref name="result" /> then contains <see cref="P:System.Text.Rune.ReplacementChar" />, and <paramref name="charsConsumed" /> contains the length of the input buffer.

<see cref="F:System.Buffers.OperationStatus.InvalidData" /> if the source buffer begins with an ill-formed UTF-16 encoded scalar value. <paramref name="result" /> then contains <see cref="P:System.Text.Rune.ReplacementChar" />, and <paramref name="charsConsumed" /> contains the number of <see cref="T:System.Char" /> values used to encode the ill-formed sequence.

.</returns>

<remarks>

<format type="text/markdown"><![CDATA[

]]></format>

</remarks>

</Docs>

</Member>

<Member MemberName="DecodeFromUtf8">

<MemberSignature Language="C#" Value="public static System.Buffers.OperationStatus DecodeFromUtf8 (ReadOnlySpan&lt;byte&gt; source, out System.Text.Rune result, out int bytesConsumed);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Buffers.OperationStatus DecodeFromUtf8(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; source, [out] valuetype System.Text.Rune&amp; result, [out] int32&amp; bytesConsumed) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.DecodeFromUtf8(System.ReadOnlySpan{System.Byte},System.Text.Rune@,System.Int32@)" />

<MemberSignature Language="VB.NET" Value="Public Shared Function DecodeFromUtf8 (source As ReadOnlySpan(Of Byte), ByRef result As Rune, ByRef bytesConsumed As Integer) As OperationStatus" />

<MemberSignature Language="F#" Value="static member DecodeFromUtf8 : ReadOnlySpan&lt;byte&gt; * Rune * int -&gt; System.Buffers.OperationStatus" Usage="System.Text.Rune.DecodeFromUtf8 (source, result, bytesConsumed)" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; static System::Buffers::OperationStatus DecodeFromUtf8(ReadOnlySpan&lt;System::Byte&gt; source, [Runtime::InteropServices::Out] System::Text::Rune % result, [Runtime::InteropServices::Out] int % bytesConsumed);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Buffers.OperationStatus</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="source" Type="System.ReadOnlySpan&lt;System.Byte&gt;" />

<Parameter Name="result" Type="System.Text.Rune" RefType="out" />

<Parameter Name="bytesConsumed" Type="System.Int32" RefType="out" />

</Parameters>

<Docs>

<param name="source">A read-only UTF-8 encoded byte span.</param>

<param name="result">When this method returns, the decoded rune.</param>

<param name="bytesConsumed">When this method returns, the number of bytes read to create the rune.</param>

<summary>Decodes the <see cref="T:System.Text.Rune" /> at the beginning of the provided UTF-8 source buffer.</summary>

<returns>

<see cref="F:System.Buffers.OperationStatus.Done" /> if the source buffer begins with a valid UTF-8 encoded scalar value. <paramref name="result" /> then contains the decoded <see cref="T:System.Text.Rune" />, and <paramref name="bytesConsumed" /> contains the number of <see cref="T:System.Byte" /> values used in the input buffer to encode the <see cref="T:System.Text.Rune" />.

<see cref="F:System.Buffers.OperationStatus.NeedMoreData" /> if the source buffer is empty or contains only a standalone UTF-8 high surrogate character. <paramref name="result" /> then contains <see cref="P:System.Text.Rune.ReplacementChar" />, and <paramref name="bytesConsumed" /> contains the length of the input buffer.

<see cref="F:System.Buffers.OperationStatus.InvalidData" /> if the source buffer begins with an ill-formed UTF-8 encoded scalar value. <paramref name="result" /> then contains <see cref="P:System.Text.Rune.ReplacementChar" />, and <paramref name="bytesConsumed" /> contains the number of <see cref="T:System.Byte" /> values used in the input buffer to encode the ill-formed sequence.

.</returns>

<remarks>

<format type="text/markdown"><![CDATA[

]]></format>

</remarks>

</Docs>

</Member>

<Member MemberName="DecodeLastFromUtf16">

<MemberSignature Language="C#" Value="public static System.Buffers.OperationStatus DecodeLastFromUtf16 (ReadOnlySpan&lt;char&gt; source, out System.Text.Rune result, out int charsConsumed);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Buffers.OperationStatus DecodeLastFromUtf16(valuetype System.ReadOnlySpan`1&lt;char&gt; source, [out] valuetype System.Text.Rune&amp; result, [out] int32&amp; charsConsumed) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.DecodeLastFromUtf16(System.ReadOnlySpan{System.Char},System.Text.Rune@,System.Int32@)" />

<MemberSignature Language="VB.NET" Value="Public Shared Function DecodeLastFromUtf16 (source As ReadOnlySpan(Of Char), ByRef result As Rune, ByRef charsConsumed As Integer) As OperationStatus" />

<MemberSignature Language="F#" Value="static member DecodeLastFromUtf16 : ReadOnlySpan&lt;char&gt; * Rune * int -&gt; System.Buffers.OperationStatus" Usage="System.Text.Rune.DecodeLastFromUtf16 (source, result, charsConsumed)" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; static System::Buffers::OperationStatus DecodeLastFromUtf16(ReadOnlySpan&lt;char&gt; source, [Runtime::InteropServices::Out] System::Text::Rune % result, [Runtime::InteropServices::Out] int % charsConsumed);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Buffers.OperationStatus</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="source" Type="System.ReadOnlySpan&lt;System.Char&gt;" />

<Parameter Name="result" Type="System.Text.Rune" RefType="out" />

<Parameter Name="charsConsumed" Type="System.Int32" RefType="out" />

</Parameters>

<Docs>

<param name="source">A read-only UTF-16 encoded character span.</param>

<param name="result">When this method returns, the decoded rune.</param>

<param name="charsConsumed">When this method returns, the number of bytes read to create the rune.</param>

<summary>Decodes the <see cref="T:System.Text.Rune" /> at the end of the provided UTF-16 source buffer.</summary>

<returns>

<see cref="F:System.Buffers.OperationStatus.Done" /> if the source buffer begins with a valid UTF-16 encoded scalar value. <paramref name="result" /> then contains the decoded <see cref="T:System.Text.Rune" />, and <paramref name="charsConsumed" /> contains the number of <see cref="T:System.Char" /> values used in the input buffer to encode the <see cref="T:System.Text.Rune" />.

<see cref="F:System.Buffers.OperationStatus.NeedMoreData" /> if the source buffer is empty or contains only a standalone UTF-16 high surrogate character. <paramref name="result" /> then contains <see cref="P:System.Text.Rune.ReplacementChar" />, and <paramref name="charsConsumed" /> contains the length of the input buffer.

<see cref="F:System.Buffers.OperationStatus.InvalidData" /> if the source buffer begins with an ill-formed UTF-16 encoded scalar value. <paramref name="result" /> then contains <see cref="P:System.Text.Rune.ReplacementChar" />, and <paramref name="charsConsumed" /> contains the number of <see cref="T:System.Char" /> values used to encode the ill-formed sequence.

.</returns>

<remarks>

<format type="text/markdown"><![CDATA[

]]></format>

</remarks>

</Docs>

</Member>

<Member MemberName="DecodeLastFromUtf8">

<MemberSignature Language="C#" Value="public static System.Buffers.OperationStatus DecodeLastFromUtf8 (ReadOnlySpan&lt;byte&gt; source, out System.Text.Rune value, out int bytesConsumed);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Buffers.OperationStatus DecodeLastFromUtf8(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; source, [out] valuetype System.Text.Rune&amp; value, [out] int32&amp; bytesConsumed) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.DecodeLastFromUtf8(System.ReadOnlySpan{System.Byte},System.Text.Rune@,System.Int32@)" />

<MemberSignature Language="VB.NET" Value="Public Shared Function DecodeLastFromUtf8 (source As ReadOnlySpan(Of Byte), ByRef value As Rune, ByRef bytesConsumed As Integer) As OperationStatus" />

<MemberSignature Language="F#" Value="static member DecodeLastFromUtf8 : ReadOnlySpan&lt;byte&gt; * Rune * int -&gt; System.Buffers.OperationStatus" Usage="System.Text.Rune.DecodeLastFromUtf8 (source, value, bytesConsumed)" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; static System::Buffers::OperationStatus DecodeLastFromUtf8(ReadOnlySpan&lt;System::Byte&gt; source, [Runtime::InteropServices::Out] System::Text::Rune % value, [Runtime::InteropServices::Out] int % bytesConsumed);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Buffers.OperationStatus</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="source" Type="System.ReadOnlySpan&lt;System.Byte&gt;" />

<Parameter Name="value" Type="System.Text.Rune" RefType="out" />

<Parameter Name="bytesConsumed" Type="System.Int32" RefType="out" />

</Parameters>

<Docs>

<param name="source">A read-only UTF-8 encoded byte span.</param>

<param name="value">When this method returns, the decoded rune.</param>

<param name="bytesConsumed">When this method returns, the number of bytes read to create the rune.</param>

<summary>Decodes the <see cref="T:System.Text.Rune" /> at the end of the provided UTF-8 source buffer.</summary>

<returns>

<see cref="F:System.Buffers.OperationStatus.Done" /> if the source buffer ends with a valid UTF-8 encoded scalar value. <paramref name="value" /> then contains the decoded <see cref="T:System.Text.Rune" />, and <paramref name="bytesConsumed" /> contains the number of <see cref="T:System.Byte" /> values used in the input buffer to encode the <see cref="T:System.Text.Rune" />.

<see cref="F:System.Buffers.OperationStatus.NeedMoreData" /> if the source buffer is empty or contains only a standalone UTF-8 high surrogate character. <paramref name="value" /> then contains <see cref="P:System.Text.Rune.ReplacementChar" />, and <paramref name="bytesConsumed" /> contains the length of the input buffer.

<see cref="F:System.Buffers.OperationStatus.InvalidData" /> if the source buffer ends with an ill-formed UTF-8 encoded scalar value. <paramref name="value" /> then contains <see cref="P:System.Text.Rune.ReplacementChar" />, and <paramref name="bytesConsumed" /> contains the number of <see cref="T:System.Byte" /> values used in the input buffer to encode the ill-formed sequence.

</returns>

<remarks>

<format type="text/markdown"><![CDATA[

]]></format>

</remarks>

</Docs>

</Member>

<Member MemberName="EncodeToUtf16">

<MemberSignature Language="C#" Value="public int EncodeToUtf16 (Span&lt;char&gt; destination);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 EncodeToUtf16(valuetype System.Span`1&lt;char&gt; destination) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.EncodeToUtf16(System.Span{System.Char})" />

<MemberSignature Language="VB.NET" Value="Public Function EncodeToUtf16 (destination As Span(Of Char)) As Integer" />

<MemberSignature Language="F#" Value="member this.EncodeToUtf16 : Span&lt;char&gt; -&gt; int" Usage="rune.EncodeToUtf16 destination" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; int EncodeToUtf16(Span&lt;char&gt; destination);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Int32</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="destination" Type="System.Span&lt;System.Char&gt;" />

</Parameters>

<Docs>

<param name="destination">The buffer to which to write this value as UTF-16.</param>

<summary>Encodes this <see cref="T:System.Text.Rune" /> to a UTF-16 destination buffer.</summary>

<returns>The number of <see cref="T:System.Char" /> values written to <paramref name="destination" />.</returns>

<remarks>To be added.</remarks>

<exception cref="T:System.ArgumentException">

<paramref name="destination" /> is not large enough to hold the output.</exception>

</Docs>

</Member>

<Member MemberName="EncodeToUtf8">

<MemberSignature Language="C#" Value="public int EncodeToUtf8 (Span&lt;byte&gt; destination);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 EncodeToUtf8(valuetype System.Span`1&lt;unsigned int8&gt; destination) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.EncodeToUtf8(System.Span{System.Byte})" />

<MemberSignature Language="VB.NET" Value="Public Function EncodeToUtf8 (destination As Span(Of Byte)) As Integer" />

<MemberSignature Language="F#" Value="member this.EncodeToUtf8 : Span&lt;byte&gt; -&gt; int" Usage="rune.EncodeToUtf8 destination" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; int EncodeToUtf8(Span&lt;System::Byte&gt; destination);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Int32</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="destination" Type="System.Span&lt;System.Byte&gt;" />

</Parameters>

<Docs>

<param name="destination">The buffer to which to write this value as UTF-8.</param>

<summary>Encodes this <see cref="T:System.Text.Rune" /> to a UTF-8 destination buffer.</summary>

<returns>The number of <see cref="T:System.Byte" /> values written to <paramref name="destination" />.</returns>

<remarks>To be added.</remarks>

<exception cref="T:System.ArgumentException">

<paramref name="destination" /> is not large enough to hold the output.</exception>

</Docs>

</Member>

<Member MemberName="Equals">

<MemberSignature Language="C#" Value="public override bool Equals (object? obj);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.Equals(System.Object)" />

<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />

<MemberSignature Language="F#" Value="override this.Equals : obj -&gt; bool" Usage="rune.Equals obj" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; override bool Equals(System::Object ^ obj);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Boolean</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="obj" Type="System.Object">

<Attributes>

<Attribute FrameworkAlternate="net-10.0;net-11.0;net-6.0;net-7.0;net-8.0;net-9.0">

<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.NotNullWhen(true)]</AttributeName>

<AttributeName Language="F#">[&lt;System.Diagnostics.CodeAnalysis.NotNullWhen(true)&gt;]</AttributeName>

</Attribute>

</Attributes>

</Parameter>

</Parameters>

<Docs>

<param name="obj">The object to compare with the current instance.</param>

<summary>Returns a value that indicates whether the current instance and a specified object are equal.</summary>

<returns>

<see langword="true" /> if <paramref name="obj" /> is of type <see cref="T:System.Text.Rune" /> and is equal to the current instance; otherwise, <see langword="false" />.</returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="Equals">

<MemberSignature Language="C#" Value="public bool Equals (System.Text.Rune other);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(valuetype System.Text.Rune other) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.Equals(System.Text.Rune)" />

<MemberSignature Language="VB.NET" Value="Public Function Equals (other As Rune) As Boolean" />

<MemberSignature Language="F#" Value="override this.Equals : System.Text.Rune -&gt; bool" Usage="rune.Equals other" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual bool Equals(System::Text::Rune other);" />

<MemberType>Method</MemberType>

<Implements>

<InterfaceMember>M:System.IEquatable`1.Equals(`0)</InterfaceMember>

</Implements>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Boolean</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="other" Type="System.Text.Rune" />

</Parameters>

<Docs>

<param name="other">The object to compare with the current instance.</param>

<summary>Returns a value that indicates whether the current instance and a specified rune are equal.</summary>

<returns>

<see langword="true" /> if the current instance and <paramref name="other" /> are equal; otherwise, <see langword="false" />.</returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="Equals">

<MemberSignature Language="C#" Value="public bool Equals (System.Text.Rune other, StringComparison comparisonType);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Equals(valuetype System.Text.Rune other, valuetype System.StringComparison comparisonType) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.Equals(System.Text.Rune,System.StringComparison)" />

<MemberSignature Language="VB.NET" Value="Public Function Equals (other As Rune, comparisonType As StringComparison) As Boolean" />

<MemberSignature Language="F#" Value="override this.Equals : System.Text.Rune * StringComparison -&gt; bool" Usage="rune.Equals (other, comparisonType)" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; bool Equals(System::Text::Rune other, StringComparison comparisonType);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Boolean</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="other" Type="System.Text.Rune" Index="0" FrameworkAlternate="net-11.0" />

<Parameter Name="comparisonType" Type="System.StringComparison" Index="1" FrameworkAlternate="net-11.0" />

</Parameters>

<Docs>

<param name="other">To be added.</param>

<param name="comparisonType">To be added.</param>

<summary>To be added.</summary>

<returns>To be added.</returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="GetHashCode">

<MemberSignature Language="C#" Value="public override int GetHashCode ();" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.GetHashCode" />

<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />

<MemberSignature Language="F#" Value="override this.GetHashCode : unit -&gt; int" Usage="rune.GetHashCode " />

<MemberSignature Language="C++ CLI" Value="public:&#xA; override int GetHashCode();" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Int32</ReturnType>

</ReturnValue>

<Parameters />

<Docs>

<summary>Returns the hash code for this instance.</summary>

<returns>The hash code for this instance.</returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="GetNumericValue">

<MemberSignature Language="C#" Value="public static double GetNumericValue (System.Text.Rune value);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig float64 GetNumericValue(valuetype System.Text.Rune value) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.GetNumericValue(System.Text.Rune)" />

<MemberSignature Language="VB.NET" Value="Public Shared Function GetNumericValue (value As Rune) As Double" />

<MemberSignature Language="F#" Value="static member GetNumericValue : System.Text.Rune -&gt; double" Usage="System.Text.Rune.GetNumericValue value" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; static double GetNumericValue(System::Text::Rune value);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Double</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="value" Type="System.Text.Rune" />

</Parameters>

<Docs>

<param name="value">The rune for which to get the numeric value.</param>

<summary>Gets the numeric value associated with the specified rune.</summary>

<returns>The numeric value associated with <paramref name="value" />, or -1 if <paramref name="value" /> doesn't represent a numeric character.</returns>

<remarks>

<format type="text/markdown"><![CDATA[

]]></format>

</remarks>

</Docs>

</Member>

<Member MemberName="GetRuneAt">

<MemberSignature Language="C#" Value="public static System.Text.Rune GetRuneAt (string input, int index);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Text.Rune GetRuneAt(string input, int32 index) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.GetRuneAt(System.String,System.Int32)" />

<MemberSignature Language="VB.NET" Value="Public Shared Function GetRuneAt (input As String, index As Integer) As Rune" />

<MemberSignature Language="F#" Value="static member GetRuneAt : string * int -&gt; System.Text.Rune" Usage="System.Text.Rune.GetRuneAt (input, index)" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; static System::Text::Rune GetRuneAt(System::String ^ input, int index);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Text.Rune</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="input" Type="System.String" />

<Parameter Name="index" Type="System.Int32" />

</Parameters>

<Docs>

<param name="input">The string from which to create the rune.</param>

<param name="index">The starting position in <paramref name="input" /> at which to create the rune.</param>

<summary>Gets the <see cref="T:System.Text.Rune" /> that begins at a specified position in a string.</summary>

<returns>The rune obtained from <paramref name="input" /> at the specified <paramref name="index" />.</returns>

<remarks>

<format type="text/markdown"><![CDATA[

]]></format>

</remarks>

<exception cref="T:System.ArgumentNullException">

<paramref name="input" /> is <see langword="null" />.</exception>

<exception cref="T:System.ArgumentException">

<paramref name="index" /> does not reference the start of a valid scalar value in <paramref name="input" />.</exception>

<exception cref="T:System.ArgumentOutOfRangeException">

<paramref name="index" /> is outside the range of <paramref name="input" />.</exception>

</Docs>

</Member>

<Member MemberName="GetUnicodeCategory">

<MemberSignature Language="C#" Value="public static System.Globalization.UnicodeCategory GetUnicodeCategory (System.Text.Rune value);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Globalization.UnicodeCategory GetUnicodeCategory(valuetype System.Text.Rune value) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.GetUnicodeCategory(System.Text.Rune)" />

<MemberSignature Language="VB.NET" Value="Public Shared Function GetUnicodeCategory (value As Rune) As UnicodeCategory" />

<MemberSignature Language="F#" Value="static member GetUnicodeCategory : System.Text.Rune -&gt; System.Globalization.UnicodeCategory" Usage="System.Text.Rune.GetUnicodeCategory value" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; static System::Globalization::UnicodeCategory GetUnicodeCategory(System::Text::Rune value);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Globalization.UnicodeCategory</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="value" Type="System.Text.Rune" />

</Parameters>

<Docs>

<param name="value">The rune for which to get the Unicode category.</param>

<summary>Gets the Unicode category associated with the specified rune.</summary>

<returns>The Unicode category associated with <paramref name="value" />.</returns>

<remarks>

<format type="text/markdown"><![CDATA[

]]></format>

</remarks>

</Docs>

</Member>

<Member MemberName="IsAscii">

<MemberSignature Language="C#" Value="public bool IsAscii { get; }" />

<MemberSignature Language="ILAsm" Value=".property instance bool IsAscii" />

<MemberSignature Language="DocId" Value="P:System.Text.Rune.IsAscii" />

<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsAscii As Boolean" />

<MemberSignature Language="F#" Value="member this.IsAscii : bool" Usage="System.Text.Rune.IsAscii" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; property bool IsAscii { bool get(); };" />

<MemberType>Property</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Boolean</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets a value that indicates whether the scalar value associated with this <see cref="T:System.Text.Rune" /> is within the ASCII encoding range.</summary>

<value>

<see langword="true" /> if the scalar value associated is within the ASCII encoding range ([ U+0000..U+007F ]) and therefore representable by a single UTF-8 code unit; otherwise, <see langword="false" />.</value>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="IsBmp">

<MemberSignature Language="C#" Value="public bool IsBmp { get; }" />

<MemberSignature Language="ILAsm" Value=".property instance bool IsBmp" />

<MemberSignature Language="DocId" Value="P:System.Text.Rune.IsBmp" />

<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsBmp As Boolean" />

<MemberSignature Language="F#" Value="member this.IsBmp : bool" Usage="System.Text.Rune.IsBmp" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; property bool IsBmp { bool get(); };" />

<MemberType>Property</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Boolean</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets a value that indicates whether the scalar value associated with this <see cref="T:System.Text.Rune" /> is within the BMP encoding range.</summary>

<value>

<see langword="true" /> if the scalar value associated is within the BMP encoding range ([ U+0000..U+FFFF ]) and therefore representable by a single UTF-16 code unit; otherwise, <see langword="false" />.</value>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="IsControl">

<MemberSignature Language="C#" Value="public static bool IsControl (System.Text.Rune value);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsControl(valuetype System.Text.Rune value) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.IsControl(System.Text.Rune)" />

<MemberSignature Language="VB.NET" Value="Public Shared Function IsControl (value As Rune) As Boolean" />

<MemberSignature Language="F#" Value="static member IsControl : System.Text.Rune -&gt; bool" Usage="System.Text.Rune.IsControl value" />

<MemberSignature Language="C++ CLI" Value="public:&#xA; static bool IsControl(System::Text::Rune value);" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

<AssemblyVersion>4.2.1.0</AssemblyVersion>

<AssemblyVersion>4.2.2.0</AssemblyVersion>

<AssemblyVersion>5.0.0.0</AssemblyVersion>

<AssemblyVersion>6.0.0.0</AssemblyVersion>

<AssemblyVersion>7.0.0.0</AssemblyVersion>

<AssemblyVersion>8.0.0.0</AssemblyVersion>

<AssemblyVersion>9.0.0.0</AssemblyVersion>

<AssemblyVersion>10.0.0.0</AssemblyVersion>

<AssemblyVersion>11.0.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Boolean</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="value" Type="System.Text.Rune" />

</Parameters>

<Docs>

<param name="value">The rune to evaluate.</param>

<summary>Returns a value that indicates whether the specified rune is categorized as a control character.</summary>

<returns>

<see langword="true" /> if <paramref name="value" /> is a control character; otherwise, <see langword="false" />.</returns>

<remarks>

<format type="text/markdown"><![CDATA[

]]></format>

</remarks>

</Docs>

</Member>

<Member MemberName="IsDigit">

<MemberSignature Language="C#" Value="public static bool IsDigit (System.Text.Rune value);" />

<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsDigit(valuetype System.Text.Rune value) cil managed" />

<MemberSignature Language="DocId" Value="M:System.Text.Rune.IsDigit(System.Text.Rune)" />