After failing to get something like the following to compile:
public class Gen<T> where T : System.Array
{
}
with the error
A constraint cannot be special class `System.Array'
I started wondering, what exactly is a "special class"?
People often seem to get the same kind of error when they specify System.Enum
in a generic constraint. I got the same results with System.Object
, System.Delegate
, System.MulticastDelegate
and System.ValueType
too.
Are there more of them? I cannot find any info on "special classes" in C#.
Also, what is so special about those classes that we can't use them as a generic type constraint?
As per C# 4.0 Language Specification (Coded : [10.1.5] Type parameter constraints) tells two things:
When you define a generic class, you can apply restrictions to the kinds of types that client code can use for type arguments when it instantiates your class. If client code tries to instantiate your class by using a type that is not allowed by a constraint, the result is a compile-time error. These restrictions are called constraints. Constraints are specified by using the where contextual keyword. If you want to constrain a generic type to be a reference type, use : class.
This will prohibit the generic type from being a value type, such as int or a struct etc.
Also, Constraint cannot be special class 'identifier' The following types may not be used as constraints:
I found a Jon Skeet comment from 2008 on a similar question: Why is the
System.Enum
constraint not supported.I know this is a bit off topic, but he asked Eric Lippert (the C# team) about it and they provided this answer:
From the Roslyn source code, it looks like a list of hardcoded types:
Source: Binder_Constraints.cs IsValidConstraintType
I've found it using a GitHub search: "A constraint cannot be special class"
The following can be found in CLR via C# 4th Edition:
Primary Constraints
A type parameter can specify zero primary constraints or one primary constraint. A primary constraint can be a reference type that identifies a class that is not sealed. You cannot specify one of the following special reference types: System.Object, System.Array, System.Delegate, System.MulticastDelegate, System.ValueType, System.Enum, or System.Void. When specifying a reference type constraint, you are promising the compiler that a specified type argument will either be of the same type or of a type derived from the constraint type.
There are certain classes in the Framework which effectively pass on special characteristics to all types derived from them but do not possess those characteristics themselves. The CLR itself imposes no prohibition against using those classes as constraints, but generic types constrained to them would not acquire the non-inherited characteristics the way concrete types would. The creators of C# decided that because such behavior might confuse some people, and they failed to see any usefulness to it, they should prohibit such constraints rather than allow them to behave as they do in the CLR.
If, for example, one were allowed to write:
void CopyArray<T>(T dest, T source, int start, int count)
; one would be able to passdest
andsource
to methods which expect an argument of typeSystem.Array
; further, one would get compile-time validation thatdest
andsource
were the compatible array types, but one would not be able to access elements of the array using the[]
operator.The inability to use
Array
as a constraint is mostly pretty easy to work around, sincevoid CopyArray<T>(T[] dest, T[] source, int start, int count)
will work in almost all situation where the former method would work. It does, however, have a weakness: the former method would work in the scenario that one or both of the arguments was of typeSystem.Array
while rejecting cases where the arguments are incompatible array types; adding an overload where both arguments were of typeSystem.Array
would make the code accept the additional cases it should accept, but also make it erroneously accept cases it should not.I find the decision to outlaw most of the special constraints irksome. The only one which would have zero semantic meaning would be
System.Object
[since if that were legal as a constraint, anything would satisfy it].System.ValueType
probably wouldn't be very useful, since references of typeValueType
don't really have much in common with value types, but it might plausibly have some value in cases involving Reflection. BothSystem.Enum
andSystem.Delegate
would have some real uses, but since the creators of C# didn't think of them they're outlawed for no good reason.I don't think, that there exists any official definition of "special classes"/"special types".
You may think about them a a types, which can't be used with semantic of "regular" types:
P.S. I'd add
System.Void
to the list.