CA1832: Usar AsSpan o AsMemory en lugar de indizadores basados en intervalos para obtener la parte ReadOnlySpan o ReadOnlyMemory de una matriz
Propiedad | Value |
---|---|
Identificador de la regla | CA1832 |
Título | Usar AsSpan o AsMemory en lugar de indizadores basados en intervalos para obtener la parte ReadOnlySpan o ReadOnlyMemory de una matriz |
Categoría | Rendimiento |
La corrección es problemática o no problemática | Poco problemático |
Habilitado de forma predeterminada en .NET 9 | Como sugerencia |
Causa
Al usar un indizador de intervalo en una matriz y asignar implícitamente el valor a ReadOnlySpan<T> o ReadOnlyMemory<T>.
Descripción de la regla
El indexador de intervalos de una Span<T> es una operación Slice que no es de copia. Pero para el indexador de intervalo en una matriz, el método GetSubArray se usará en lugar de Slice, que genera una copia de la parte solicitada de la matriz. Esta copia no suele ser necesaria cuando se usa implícitamente como valor ReadOnlySpan<T> o ReadOnlyMemory<T>. Si no se pretende obtener una copia, use el método AsSpan o AsMemory para evitar la copia innecesaria. Si se pretende obtener la copia, asígnela primero a una variable local o agregue una conversión explícita.
El analizador solo informa cuando se usa una conversión implícita en el resultado de la operación del indizador de intervalo.
Detecta
Conversiones implícitas:
ReadOnlySpan<SomeT> slice = arr[a..b];
ReadOnlyMemory<SomeT> slice = arr[a..b];
No detecta
Conversiones explícitas:
ReadOnlySpan<SomeT> slice = (ReadOnlySpan<SomeT>)arr[a..b];
ReadOnlyMemory<SomeT> slice = (ReadOnlyMemory<SomeT>)arr[a..b];
Cómo corregir infracciones
Para corregir una infracción de esta regla, use el método de extensión AsSpan o AsMemory para evitar la creación de copias de datos innecesarias.
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];
...
}
}
Sugerencia
Hay disponible una corrección de código para esta regla en Visual Studio. Para usarla, coloque el cursor sobre la infracción y presione Ctrl+. (punto). Elija Usar AsSpan en lugar de indizadores basados en intervalos para una matriz en la lista de opciones que se muestra.
También puede evitar esta advertencia si agrega una conversión explícita.
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];
...
}
}
Cuándo suprimir las advertencias
Se puede suprimir una infracción de esta regla si la creación de una copia es intencional.
Supresión de una advertencia
Si solo quiere suprimir una única infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y volver a habilitar la regla.
#pragma warning disable CA1832
// The code that's violating the rule is on this line.
#pragma warning restore CA1832
Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad en none
del archivo de configuración.
[*.{cs,vb}]
dotnet_diagnostic.CA1832.severity = none
Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.
Reglas relacionadas
- CA1831: Usar AsSpan en lugar de indizadores basados en intervalos para una cadena cuando proceda
- CA1833: Usar AsSpan o AsMemory en lugar de indizadores basados en intervalos para obtener la parte Span o Memory de una matriz