The APIs listed here are currently marked as preview APIs, and as such may change in the future (we don't guarante binary or source compatibility between releases for these APIs).
We've marked these APIs using the Experimental attribute, which means that compilation error will be shown if they're used:
error APL0001: 'PreviewAPI' is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
This means that it's not possible to use these preview APIs by accident, the diagnostic has to be explicitly ignored.
Example program consuming preview API:
using System.Diagnostics.CodeAnalysis;
class App
{
public static void Main ()
{
Do.Something ();
}
}
[Experimental ("APL0001")]
class Do {
public static void Something () {}
}this will show:
Program.cs(8,9): error APL0001: 'Do' is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
Then ignore the warning in order to make the code compile:
using System.Diagnostics.CodeAnalysis;
class App
{
public unsafe static void Main ()
{
#pragma warning disable APL0001
Do.Something ();
#pragma warning restore APL0001
}
}
[Experimental ("APL0001")]
class Do {
public static void Something () {}
}Our diagnostic IDs will be of the format APL#### - for instance APL0001 -
where the number is just monotonically increasing since the previous number,
without any specific meaning.
References:
- https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.codeanalysis.experimentalattribute?view=net-8.0
- https://learn.microsoft.com/en-us/dotnet/fundamentals/apicompat/preview-apis#experimentalattribute
CryptoTokenKit requires special hardware to test, so it's not trivial for us to do so. Thus we need customer input in order to validate the API, and as such we mark every type in this framework as preview API for a while.
We've tentatively set .NET 10 as the release when we'll stop marking CryptoTokenKit as preview API.
The diagnostic id for CryptoTokenKit is APL0001.