Skip to content

Commit 3b4ccd8

Browse files
committed
enumconverter breaking change
1 parent a512438 commit 3b4ccd8

File tree

3 files changed

+52
-0
lines changed

3 files changed

+52
-0
lines changed

docs/core/compatibility/9.0.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,12 @@ If you're migrating an app to .NET 9, the breaking changes listed here might aff
6161
|-----------------------------------------------------------------------------------|---------------------|--------------------|
6262
| [Deprecated desktop Windows/macOS/Linux MonoVM runtime packages](deployment/9.0/monovm-packages.md) | Source incompatible | Preview 7 |
6363

64+
## Extensions
65+
66+
| Title | Type of change | Introduced version |
67+
|----------------------------------------------------------------------------------------|---------------------|--------------------|
68+
| [EnumConverter validates registered types to be enum](networking/9.0/enumconverter.md) | Binary incompatible | Preview 7 |
69+
6470
## JIT compiler
6571

6672
| Title | Type of change | Introduced version |
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: "Breaking change: EnumConverter validates registered types to be enum"
3+
description: Learn about the .NET 9 breaking change in networking where EnumConverter now validates that the type to be registered is an enum type.
4+
ms.date: 10/04/2024
5+
---
6+
# EnumConverter validates registered types to be enum
7+
8+
<xref:System.ComponentModel.EnumConverter> is a type converter that converts to and from an `enum` type. EnumConverter now validates that the type to be registered is of an `enum` type.
9+
10+
## Previous behavior
11+
12+
Previously, the type to be registered was not validated to be an `enum` type.
13+
14+
## New behavior
15+
16+
Starting in .NET 9, <xref:System.ComponentModel.EnumConverter> throws an <xref:System.ArgumentException> if the type to be converted is not an `enum` type. Any derived classes of <xref:System.ComponentModel.EnumConverter> should also respect this requirement.
17+
18+
## Version introduced
19+
20+
.NET 9 Preview 7
21+
22+
## Type of breaking change
23+
24+
This change can affect [binary compatibility](../../categories.md#binary-compatibility) and is also a [behavioral change](../../categories.md#behavioral-change).
25+
26+
## Reason for change
27+
28+
It is logical to enforce the requirement that <xref:System.ComponentModel.EnumConverter> be used to convert to and from `enum` types only. It was likely an oversight that this requirement wasn't added earlier.
29+
30+
However, the primary driving factor for this change was for trimming purposes. [Trimming](../../../deploying/trimming/prepare-libraries-for-trimming.md) doesn't trim `enum` types, but using <xref:System.ComponentModel.EnumConverter> for `enum` types required <xref:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute> annotation for an `enum` type. This means that using `EnumConverter` generates unnecessary trim warnings. A recent change removed the annotation requirement. Part of the reason for that change was to enforce that `EnumConverter` only be used with `enums`.
31+
32+
## Recommended action
33+
34+
There is no easy workaround if an <xref:System.ComponentModel.EnumConverter> is used to convert to and from a non-`enum` type.
35+
36+
## Affected APIs
37+
38+
- <xref:System.ComponentModel.EnumConverter.%23ctor(System.Type)> constructor

docs/core/compatibility/toc.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ items:
5858
items:
5959
- name: Deprecated desktop Windows/macOS/Linux MonoVM runtime packages
6060
href: deployment/9.0/monovm-packages.md
61+
- name: Extensions
62+
items:
63+
- name: EnumConverter validates registered types to be enum
64+
href: networking/9.0/enumconverter.md
6165
- name: JIT compiler
6266
items:
6367
- name: Floating point to integer conversions are saturating
@@ -1546,6 +1550,10 @@ items:
15461550
href: /ef/core/what-is-new/ef-core-3.x/breaking-changes?toc=/dotnet/core/compatibility/toc.json&bc=/dotnet/breadcrumb/toc.json
15471551
- name: Extensions
15481552
items:
1553+
- name: .NET 9
1554+
items:
1555+
- name: EnumConverter validates registered types to be enum
1556+
href: networking/9.0/enumconverter.md
15491557
- name: .NET 8
15501558
items:
15511559
- name: ActivatorUtilities.CreateInstance behaves consistently

0 commit comments

Comments
 (0)