| description |
|---|
Use KernelPlatform.IsOnUnix() |
This analyzer provides the following strings:
| Context | String |
|---|---|
| Error List | Caller uses RuntimeInformation.IsOSPlatform(OSPlatform.Linux) instead of KernelPlatform.IsOnUnix() |
| Suggestion Box | Use KernelPlatform.IsOnUnix() instead of RuntimeInformation.IsOSPlatform(OSPlatform.Linux) |
| Description | KernelPlatform.IsOnUnix() is more readable and less verbose than RuntimeInformation.IsOSPlatform(OSPlatform.Linux). |
This code analyzer detects the usage of IsOSPlatform from the RuntimeInformation class found in the System.Runtime.InteropServices namespace.
RuntimeInformation.IsOSPlatform is a modern way of determining the current operating system that Nitrocid is running on. However, this isn't live detection.
As a result, KernelPlatform implements a handful of platform detection functions to allow you to more accurately detect your platform. Also, it simplifies the complicated platform checking statements to its simpler equivalent.
To get a brief insight about how this analyzer works, compare the two code blocks shown to you below:
public static void MyFunction()
{
bool value = RuntimeInformation.IsOSPlatform(OSPlatform.Linux);
}
public static void MyFunction()
{
bool value = KernelPlatform.IsOnUnix();
}
You can suppress this suggestion by including it in the appropriate place, whichever is convenient.
For more information about how to suppress any warning issued by the Nitrocid analyzer, visit the below page:
{% embed url="https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/suppress-warnings" %}
We recommend that every caller which use this function use the recommended abovementioned method.