This browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can trysigning in orchanging directories.
Access to this page requires authorization. You can trychanging directories.
Note
This article is a feature specification. The specification serves as the design document for the feature. It includes proposed specification changes, along with information needed during the design and development of the feature. These articles are published until the proposed spec changes are finalized and incorporated in the current ECMA specification.
There may be some discrepancies between the feature specification and the completed implementation. Those differences are captured in the pertinentlanguage design meeting (LDM) notes.
You can learn more about the process for adopting feature speclets into the C# language standard in the article on thespecifications.
Champion issue:https://github.com/dotnet/csharplang/issues/4436
An interface is allowed to specify abstract static members that implementing classes and structs are then required to provide an explicit or implicit implementation of. The members can be accessed off of type parameters that are constrained by the interface.
There is currently no way to abstract over static members and write generalized code that applies across types that define those static members. This is particularly problematic for member kinds thatonly exist in a static form, notably operators.
This feature allows generic algorithms over numeric types, represented by interface constraints that specify the presence of given operators. The algorithms can therefore be expressed in terms of such operators:
// Interface specifies static properties and operatorsinterface IAddable<T> where T : IAddable<T>{ static abstract T Zero { get; } static abstract T operator +(T t1, T t2);}// Classes and structs (including built-ins) can implement interfacestruct Int32 : …, IAddable<Int32>{ static Int32 IAddable.operator +(Int32 x, Int32 y) => x + y; // Explicit public static int Zero => 0; // Implicit}// Generic algorithms can use static members on Tpublic static T AddAll<T>(T[] ts) where T : IAddable<T>{ T result = T.Zero; // Call static operator foreach (T t in ts) { result += t; } // Use `+` return result;}// Generic method can be applied to built-in and user-defined typesint sixtyThree = AddAll(new [] { 1, 2, 4, 8, 16, 32 });
The feature would allow static interface members to be declared virtual.
Before C# 11, instance members in interfaces are implicitly abstract (or virtual if they have a default implementation), but can optionally have anabstract
(orvirtual
) modifier. Non-virtual instance members must be explicitly marked assealed
.
Static interface members today are implicitly non-virtual, and do not allowabstract
,virtual
orsealed
modifiers.
Static interface members other than fields are allowed to also have theabstract
modifier. Abstract static members are not allowed to have a body (or in the case of properties, the accessors are not allowed to have a body).
interface I<T> where T : I<T>{ static abstract void M(); static abstract T P { get; set; } static abstract event Action E; static abstract T operator +(T l, T r); static abstract bool operator ==(T l, T r); static abstract bool operator !=(T l, T r); static abstract implicit operator T(string s); static abstract explicit operator string(T t);}
Static interface members other than fields are allowed to also have thevirtual
modifier. Virtual static members are required to have a body.
interface I<T> where T : I<T>{ static virtual void M() {} static virtual T P { get; set; } static virtual event Action E; static virtual T operator +(T l, T r) { throw new NotImplementedException(); }}
For symmetry with non-virtual instance members, static members (except fields) should be allowed an optionalsealed
modifier, even though they are non-virtual by default:
interface I0{ static sealed void M() => Console.WriteLine("Default behavior"); static sealed int f = 0; static sealed int P1 { get; set; } static sealed int P2 { get => f; set => f = value; } static sealed event Action E1; static sealed event Action E2 { add => E1 += value; remove => E1 -= value; } static sealed I0 operator +(I0 l, I0 r) => l;}
Classes and structs can implement abstract instance members of interfaces either implicitly or explicitly. An implicitly implemented interface member is a normal (virtual or non-virtual) member declaration of the class or struct that just "happens" to also implement the interface member. The member can even be inherited from a base class and thus not even be present in the class declaration.
An explicitly implemented interface member uses a qualified name to identify the interface member in question. The implementation is not directly accessible as a member on the class or struct, but only through the interface.
No new syntax is needed in classes and structs to facilitate implicit implementation of static abstract interface members. Existing static member declarations serve that purpose.
Explicit implementations of static abstract interface members use a qualified name along with thestatic
modifier.
class C : I<C>{ string _s; public C(string s) => _s = s; static void I<C>.M() => Console.WriteLine("Implementation"); static C I<C>.P { get; set; } static event Action I<C>.E // event declaration must use field accessor syntax { add { ... } remove { ... } } static C I<C>.operator +(C l, C r) => new C($"{l._s} {r._s}"); static bool I<C>.operator ==(C l, C r) => l._s == r._s; static bool I<C>.operator !=(C l, C r) => l._s != r._s; static implicit I<C>.operator C(string s) => new C(s); static explicit I<C>.operator string(C c) => c._s;}
Today all unary and binary operator declarations have some requirement involving at least one of their operands to be of typeT
orT?
, whereT
is the instance type of the enclosing type.
These requirements need to be relaxed so that a restricted operand is allowed to be of a type parameter that counts as "the instance type of the enclosing type".
In order for a type parameterT
to count as "the instance type of the enclosing type", it must meet the following requirements:
T
is a direct type parameter on the interface in which the operator declaration occurs, andT
isdirectly constrained by what the spec calls the "instance type" - i.e. the surrounding interface with its own type parameters used as type arguments.Abstract/virtual declarations of==
and!=
operators, as well as abstract/virtual declarations of implicit and explicit conversion operators will be allowed in interfaces. Derived interfaces will be allowed to implement them too.
For==
and!=
operators, at least one parameter type must be a type parameter that counts as "the instance type of the enclosing type", as defined in the previous section.
The rules for when a static member declaration in a class or struct is considered to implement a static abstract interface member, and for what requirements apply when it does, are the same as for instance members.
TBD: There may be additional or different rules necessary here that we haven't yet thought of.
We discussed the issue raised byhttps://github.com/dotnet/csharplang/issues/5955 and decided to add a restriction around usage of an interface as a type argument (https://github.com/dotnet/csharplang/blob/main/meetings/2022/LDM-2022-03-28.md#type-hole-in-static-abstracts). Here is the restriction as it was proposed byhttps://github.com/dotnet/csharplang/issues/5955 and approved by the LDM.
An interface containing or inheriting a static abstract/virtual member that does not have most specific implementation in the interface cannot be used as a type argument. If all static abstract/virtual members have most specific implementation, the interface can be used as a type argument.
A static abstract interface memberM
may be accessed on a type parameterT
using the expressionT.M
whenT
is constrained by an interfaceI
andM
is an accessible static abstract member ofI
.
T M<T>() where T : I<T>{ T.M(); T t = T.P; T.E += () => { }; return t + T.P;}
At runtime, the actual member implementation used is the one that exists on the actual type provided as a type argument.
C c = M<C>(); // The static members of C get called
Since query expressions are spec'ed as a syntactic rewrite, C# actually lets you use atype as the query source, as long as it has static members for the query operators you use! In other words, if thesyntax fits, we allow it!We think this behavior was not intentional or important in the original LINQ, and we don't want to do the work to support it on type parameters. If there are scenarios out there we will hear about them, and can choose to embrace this later.
Variance safety rules should apply to signatures of static abstract members. The addition proposed inhttps://github.com/dotnet/csharplang/blob/main/proposals/variance-safety-for-static-interface-members.md#variance-safetyshould be adjusted from
These restrictions do not apply to occurrences of types within declarations of static members.
to
These restrictions do not apply to occurrences of types within declarations ofnon-virtual, non-abstract static members.
The following bullet points
S
,S₀
andT₀
.E
has a type, letS
be that type.S
orT
are nullable value types, letSᵢ
andTᵢ
be their underlying types, otherwise letSᵢ
andTᵢ
beS
andT
, respectively.Sᵢ
orTᵢ
are type parameters, letS₀
andT₀
be their effective base classes, otherwise letS₀
andT₀
beSₓ
andTᵢ
, respectively.D
, from which user-defined conversion operators will be considered. This set consists ofS0
(ifS0
is a class or struct), the base classes ofS0
(ifS0
is a class), andT0
(ifT0
is a class or struct).U
. This set consists of the user-defined and lifted implicit conversion operators declared by the classes or structs inD
that convert from a type encompassingS
to a type encompassed byT
. IfU
is empty, the conversion is undefined and a compile-time error occurs.are adjusted as follows:
S
,S₀
andT₀
.E
has a type, letS
be that type.S
orT
are nullable value types, letSᵢ
andTᵢ
be their underlying types, otherwise letSᵢ
andTᵢ
beS
andT
, respectively.Sᵢ
orTᵢ
are type parameters, letS₀
andT₀
be their effective base classes, otherwise letS₀
andT₀
beSₓ
andTᵢ
, respectively.U
.D1
, from which user-defined conversion operators will be considered. This set consists ofS0
(ifS0
is a class or struct), the base classes ofS0
(ifS0
is a class), andT0
(ifT0
is a class or struct).U1
. This set consists of the user-defined and lifted implicit conversion operators declared by the classes or structs inD1
that convert from a type encompassingS
to a type encompassed byT
.U1
is not empty, thenU
isU1
. Otherwise,D2
, from which user-defined conversion operators will be considered. This set consists ofSᵢ
effective interface set and their base interfaces (ifSᵢ
is a type parameter), andTᵢ
effective interface set (ifTᵢ
is a type parameter).U2
. This set consists of the user-defined and lifted implicit conversion operators declared by the interfaces inD2
that convert from a type encompassingS
to a type encompassed byT
.U2
is not empty, thenU
isU2
U
is empty, the conversion is undefined and a compile-time error occurs.The following bullet points
S
,S₀
andT₀
.E
has a type, letS
be that type.S
orT
are nullable value types, letSᵢ
andTᵢ
be their underlying types, otherwise letSᵢ
andTᵢ
beS
andT
, respectively.Sᵢ
orTᵢ
are type parameters, letS₀
andT₀
be their effective base classes, otherwise letS₀
andT₀
beSᵢ
andTᵢ
, respectively.D
, from which user-defined conversion operators will be considered. This set consists ofS0
(ifS0
is a class or struct), the base classes ofS0
(ifS0
is a class),T0
(ifT0
is a class or struct), and the base classes ofT0
(ifT0
is a class).U
. This set consists of the user-defined and lifted implicit or explicit conversion operators declared by the classes or structs inD
that convert from a type encompassing or encompassed byS
to a type encompassing or encompassed byT
. IfU
is empty, the conversion is undefined and a compile-time error occurs.are adjusted as follows:
S
,S₀
andT₀
.E
has a type, letS
be that type.S
orT
are nullable value types, letSᵢ
andTᵢ
be their underlying types, otherwise letSᵢ
andTᵢ
beS
andT
, respectively.Sᵢ
orTᵢ
are type parameters, letS₀
andT₀
be their effective base classes, otherwise letS₀
andT₀
beSᵢ
andTᵢ
, respectively.U
.D1
, from which user-defined conversion operators will be considered. This set consists ofS0
(ifS0
is a class or struct), the base classes ofS0
(ifS0
is a class),T0
(ifT0
is a class or struct), and the base classes ofT0
(ifT0
is a class).U1
. This set consists of the user-defined and lifted implicit or explicit conversion operators declared by the classes or structs inD1
that convert from a type encompassing or encompassed byS
to a type encompassing or encompassed byT
.U1
is not empty, thenU
isU1
. Otherwise,D2
, from which user-defined conversion operators will be considered. This set consists ofSᵢ
effective interface set and their base interfaces (ifSᵢ
is a type parameter), andTᵢ
effective interface set and their base interfaces (ifTᵢ
is a type parameter).U2
. This set consists of the user-defined and lifted implicit or explicit conversion operators declared by the interfaces inD2
that convert from a type encompassing or encompassed byS
to a type encompassing or encompassed byT
.U2
is not empty, thenU
isU2
U
is empty, the conversion is undefined and a compile-time error occurs.Anadditional feature to this proposal is to allow static virtual members in interfaces to have default implementations, just as instance virtual/abstract members do.
One complication here is that default implementations would want to call other static virtual members "virtually". Allowing static virtual members to be called directly on the interface would require flowing a hidden type parameter representing the "self" type that the current static method really got invoked on. This seems complicated, expensive and potentially confusing.
We discussed a simpler version which maintains the limitations of the current proposal that static virtual members canonly be invoked on type parameters. Since interfaces with static virtual members will often have an explicit type parameter representing a "self" type, this wouldn't be a big loss: other static virtual members could just be called on that self type. This version is a lot simpler, and seems quite doable.
Athttps://github.com/dotnet/csharplang/blob/main/meetings/2022/LDM-2022-01-24.md#default-implementations-of-abstract-statics we decided to support Default Implementations of static members following/expanding the rules established inhttps://github.com/dotnet/csharplang/blob/main/proposals/csharp-8.0/default-interface-methods.md accordingly.
Given the following code, a user might reasonably expect it to print "True" (as it would if the constant pattern was written inline):
M(1.0);static void M<T>(T t) where T : INumberBase<T>{ Console.WriteLine(t is 1); // Error. Cannot use a numeric constant Console.WriteLine((t is int i) && (i is 1)); }
However, because the input type of the pattern is notdouble
, the constant1
pattern will first type check the incomingT
againstint
. This is unintuitive, so it is blocked until a future C# version adds better handling for numeric matching against types derived fromINumberBase<T>
. To do so, we will say that, we will explicitly recognizeINumberBase<T>
as the type that all "numbers" will derive from, and block the pattern if we're trying to match a numeric constant pattern against a number type that we can't represent the pattern in (ie, a type parameter constrained toINumberBase<T>
, or a user-defined number type that inherits fromINumberBase<T>
).
Formally, we add an exception to the definition ofpattern-compatible for constant patterns:
A constant pattern tests the value of an expression against a constant value. The constant may be any constant expression, such as a literal, the name of a declared
const
variable, or an enumeration constant. When the input value is not an open type, the constant expression is implicitly converted to the type of the matched expression; if the type of the input value is notpattern-compatible with the type of the constant expression, the pattern-matching operation is an error.If the constant expression being matched against is a numeric value, the input value is a type that inherits fromSystem.Numerics.INumberBase<T>
, and there is no constant conversion from the constant expression to the type of the input value, the pattern-matching operation is an error.
We also add a similar exception for relational patterns:
When the input is a type for which a suitable built-in binary relational operator is defined that is applicable with the input as its left operand and the given constant as its right operand, the evaluation of that operator is taken as the meaning of the relational pattern. Otherwise we convert the input to the type of the expression using an explicit nullable or unboxing conversion. It is a compile-time error if no such conversion exists.It is a compile-time error if the input type is a type parameter constrained to or a type inheriting from
System.Numerics.INumberBase<T>
and the input type has no suitable built-in binary relational operator defined. The pattern is considered not to match if the conversion fails. If the conversion succeeds then the result of the pattern-matching operation is the result of evaluating the expression e OP v where e is the converted input, OP is the relational operator, and v is the constant expression.
An alternative approach would be to have "structural constraints" directly and explicitly requiring the presence of specific operators on a type parameter. The drawbacks of that are:- This would have to be written out every time. Having a named constraint seems better.- This is a whole new kind of constraint, whereas the proposed feature utilizes the existing concept of interface constraints.- It would only work for operators, not (easily) other kinds of static members.
Seehttps://github.com/dotnet/csharplang/issues/5783 andhttps://github.com/dotnet/csharplang/blob/main/meetings/2022/LDM-2022-02-16.md#static-abstract-interfaces-and-static-classes for more information.
Was this page helpful?
Was this page helpful?