Skip to content

Commit

Permalink
EnumConverter breaking change (#42847)
Browse files Browse the repository at this point in the history
  • Loading branch information
gewarren authored Oct 31, 2024
1 parent 542b430 commit f21aff3
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/core/compatibility/9.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ If you're migrating an app to .NET 9, the breaking changes listed here might aff
| [BinaryReader.GetString() returns "\uFFFD" on malformed sequences](core-libraries/9.0/binaryreader.md) | Behavioral change | Preview 7 |
| [Creating type of array of System.Void not allowed](core-libraries/9.0/type-instance.md) | Behavioral change | Preview 1 |
| [Default `Equals()` and `GetHashCode()` throw for types marked with `InlineArrayAttribute`](core-libraries/9.0/inlinearrayattribute.md) | Behavioral change | Preview 6 |
| [EnumConverter validates registered types to be enum](core-libraries/9.0/enumconverter.md) | Behavioral change | Preview 7 |
| [FromKeyedServicesAttribute no longer injects non-keyed parameter](core-libraries/9.0/non-keyed-params.md) | Behavioral change | RC 1 |
| [IncrementingPollingCounter initial callback is asynchronous](core-libraries/9.0/async-callback.md) | Behavioral change | RC 1 |
| [Inline array struct size limit is enforced](core-libraries/9.0/inlinearray-size.md) | Behavioral change | Preview 1 |
Expand Down
38 changes: 38 additions & 0 deletions docs/core/compatibility/core-libraries/9.0/enumconverter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "Breaking change: EnumConverter validates registered types to be enum"
description: Learn about the .NET 9 breaking change where EnumConverter now validates that the type to be registered is an enum type.
ms.date: 10/04/2024
---
# EnumConverter validates registered types to be enum

<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.

## Previous behavior

Previously, the type to be registered was not validated to be an `enum` type.

## New behavior

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.

## Version introduced

.NET 9 Preview 7

## Type of breaking change

This change is a [behavioral change](../../categories.md#behavioral-change).

## Reason for change

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.

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`.

## Recommended action

There is no easy workaround if an <xref:System.ComponentModel.EnumConverter> is used to convert to and from a non-`enum` type.

## Affected APIs

- <xref:System.ComponentModel.EnumConverter.%23ctor(System.Type)> constructor
4 changes: 4 additions & 0 deletions docs/core/compatibility/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ items:
href: core-libraries/9.0/biginteger-limit.md
- name: Creating type of array of System.Void not allowed
href: core-libraries/9.0/type-instance.md
- name: EnumConverter validates registered types to be enum
href: core-libraries/9.0/enumconverter.md
- name: "`Equals`/`GetHashCode` throw for `InlineArrayAttribute` types"
href: core-libraries/9.0/inlinearrayattribute.md
- name: FromKeyedServicesAttribute no longer injects non-keyed parameter
Expand Down Expand Up @@ -1260,6 +1262,8 @@ items:
href: core-libraries/9.0/binaryreader.md
- name: Creating type of array of System.Void not allowed
href: core-libraries/9.0/type-instance.md
- name: EnumConverter validates registered types to be enum
href: core-libraries/9.0/enumconverter.md
- name: "`Equals`/`GetHashCode` throw for `InlineArrayAttribute` types"
href: core-libraries/9.0/inlinearrayattribute.md
- name: FromKeyedServicesAttribute no longer injects non-keyed parameter
Expand Down

0 comments on commit f21aff3

Please sign in to comment.