CKTIS / C#
NotNullWhenAttribute — uvjetno jamstvo da vrijednost nije null
NotNullWhenAttribute opisuje odnos između bool rezultata metode i null-stanja njezina argumenta. Omogućuje analizi nullable da prepozna sigurnu granu nakon metode za provjeru ili metode u stilu Try*, bez upotrebe operatora !.
Verzija: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification
Sintaksa
bool Method([NotNullWhen(true)] string? value)
bool TryMethod([NotNullWhen(true)] out string? value)
bool IsMissing([NotNullWhen(false)] string? value)NotNullWhenAttribute u prostoru naziva System.Diagnostics.CodeAnalysis atribut je parametra koji opisuje uvjetni postuvjet. [NotNullWhen(true)] znači da nakon normalnog povratka metode s rezultatom true argument nije null, iako njegov tip to dopušta. Skraćeni naziv atributa je NotNullWhen; konstruktor prima bool, a svojstvo ReturnValue izlaže tu vrijednost.
Atribut primijenite na parametre, uključujući parametre out i ref, a ne na povratnu vrijednost. [NotNullWhen(false)] povezuje jamstvo s rezultatom false. Suprotan rezultat sam po sebi ne znači da je argument null: atribut ne određuje njegovo stanje u toj grani.
Omogućite analizu nullable, primjerice pomoću #nullable enable. U primjeru TryGetName jamči nenull vrijednost parametra out kada vrati true, pa name.Length ne zahtijeva operator !. Atribut ne provjerava vrijednosti tijekom izvođenja niti ih mijenja; implementacija mora poštovati ugovor.
API je dostupan u ciljnom okruženju .NET 10. Postavka repozitorija LangVersion=preview ne znači da je ovaj atribut eksperimentalna značajka.
Primjeri
#nullable enable
using System;
using System.Diagnostics.CodeAnalysis;
internal static class Program
{
private static bool TryGetName(int id, [NotNullWhen(true)] out string? name)
{
name = id == 1 ? "Ada" : null;
return name is not null;
}
private static void Main()
{
foreach (int id in new[] { 1, 2 })
{
if (TryGetName(id, out string? name))
Console.WriteLine(name.Length);
else
Console.WriteLine("missing");
}
}
}Rezultat
3 missing
Prikazani kôd i navedeni rezultat provjereni su u izoliranom okruženju metodom zabilježenom u dokazu provjere za ovu točnu verziju.