CA1832: AsSpan of AsMemory gebruiken in plaats van op range gebaseerde indexeerfuncties voor het ophalen van ReadOnlySpan of ReadOnlyMemory-gedeelte van een matrix

Oorzaak

Wanneer u een bereikindexeerfunctie op een matrix gebruikt en impliciet de waarde toewijst aan ReadOnlySpan<T> of ReadOnlyMemory<T>.

Beschrijving van regel

De bereikindexeerfunctie op een Span<T> is een niet-kopieerbewerking Slice . Maar voor de bereikindexeerfunctie op een matrix wordt de methode GetSubArray gebruikt in plaats van Slice, die een kopie van het aangevraagde gedeelte van de matrix produceert. Deze kopie is meestal niet nodig wanneer deze impliciet wordt gebruikt als ReadOnlySpan<T>- of ReadOnlyMemory<T>-waarde. Als een kopie niet is bedoeld, gebruikt u de AsSpan of AsMemory methode om onnodige kopie te voorkomen. Als de kopie is bedoeld, wijst u deze eerst toe aan een lokale variabele of voegt u een expliciete cast toe.

De analyse rapporteert alleen wanneer een impliciete cast wordt gebruikt op het resultaat van de bereikindexeerbewerking.

Detecteert

Impliciete conversies:

• ReadOnlySpan<SomeT> slice = arr[a..b];
• ReadOnlyMemory<SomeT> slice = arr[a..b];

Detecteert niet

Expliciete conversies:

• ReadOnlySpan<SomeT> slice = (ReadOnlySpan<SomeT>)arr[a..b];
• ReadOnlyMemory<SomeT> slice = (ReadOnlyMemory<SomeT>)arr[a..b];

Hoe schendingen op te lossen

Als u een schending van deze regel wilt oplossen, gebruikt u de AsSpan of AsMemory extensiemethode om te voorkomen dat onnodige gegevenskopieën worden gemaakt.

class C
{
    public void TestMethod(byte[] arr)
    {
        // The violation occurs for both statements below
        ReadOnlySpan<byte> tmp1 = arr[0..2];
        ReadOnlyMemory<byte> tmp3 = arr[5..8];
        ...
    }
}

class C
{
    public void TestMethod(byte[] arr)
    {
        // The violations fixed with AsSpan or AsMemory accordingly
        ReadOnlySpan<byte> tmp1 = arr.AsSpan()[0..2];
        ReadOnlyMemory<byte> tmp3 = arr.AsMemory()[5..8];
        ...
    }
}

U kunt deze waarschuwing ook vermijden door een expliciete cast toe te voegen.

class C
{
    public void TestMethod(byte[] arr)
    {
        // The violation occurs
        ReadOnlySpan<byte> tmp1 = arr[0..2];
        ReadOnlyMemory<byte> tmp3 = arr[5..8];
        ...
    }
}

class C
{
    public void TestMethod(byte[] arr)
    {
        // The violation fixed with explicit casting
        ReadOnlySpan<byte> tmp1 = (ReadOnlySpan<byte>)arr[0..2];
        ReadOnlyMemory<byte> tmp3 = (ReadOnlyMemory<byte>)arr[5..8];
        ...
    }
}

Wanneer waarschuwingen onderdrukken

Het is veilig om een schending van deze regel te onderdrukken als het maken van een kopie is bedoeld.

Een waarschuwing onderdrukken

Als u slechts één schending wilt onderdrukken, voegt u preprocessorrichtlijnen toe aan uw bronbestand om de regel uit te schakelen en vervolgens opnieuw in te schakelen.

#pragma warning disable CA1832
// The code that's violating the rule is on this line.
#pragma warning restore CA1832

Als u de regel voor een bestand, map of project wilt uitschakelen, stelt u de ernst none ervan in op het configuratiebestand.

[*.{cs,vb}]
dotnet_diagnostic.CA1832.severity = none

Zie voor meer informatie Hoe codeanalysewaarschuwingen te onderdrukken.

Gerelateerde regels

• CA1831: AsSpan gebruiken in plaats van op bereik gebaseerde indexeerfuncties voor tekenreeksen indien van toepassing
• CA1833: AsSpan of AsMemory gebruiken in plaats van indexeerfuncties op basis van bereik voor het ophalen van span- of geheugengedeelte van een matrix

Zie ook

• Prestatieregels