Skip to content

Clarify that rune isn't available in .NET Framework #43164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 23, 2024
Merged

Clarify that rune isn't available in .NET Framework #43164

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/standard/base-types/character-encoding-introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Introduction to character encoding in .NET
description: Learn about character encoding and decoding in .NET.
ms.date: 08/11/2021
ms.date: 10/22/2024
ms.topic: conceptual
no-loc: [Rune, char, string]
dev_langs:
Expand Down Expand Up @@ -181,7 +181,10 @@ The following diagram illustrates the scalar value code points.

### The Rune type as a scalar value

Beginning with .NET Core 3.0, the <xref:System.Text.Rune?displayProperty=fullName> type represents a Unicode scalar value. **`Rune` is not available in .NET Core 2.x or .NET Framework 4.x.**
> [!IMPORTANT]
> The `Rune` type isn't available in .NET Framework.

In .NET, the <xref:System.Text.Rune?displayProperty=fullName> type represents a Unicode scalar value.

The `Rune` constructors validate that the resulting instance is a valid Unicode scalar value, otherwise they throw an exception. The following example shows code that successfully instantiates `Rune` instances because the input represents valid scalar values:

Expand Down Expand Up @@ -265,8 +268,6 @@ In .NET APIs, a grapheme cluster is called a *text element*. The following metho

:::code language="csharp" source="snippets/character-encoding-introduction/csharp/CountTextElements.cs" id="SnippetCallCountMethod":::

If you run this code in .NET Framework or .NET Core 3.1 or earlier, the text element count for the emoji shows `4`. That is due to a bug in the `StringInfo` class that was fixed in .NET 5.

### Example: splitting string instances

When splitting `string` instances, avoid splitting surrogate pairs and grapheme clusters. Consider the following example of incorrect code, which intends to insert line breaks every 10 characters in a string:
Expand Down
Loading