CA1831: Usar AsSpan en lugar de indizadores basados en intervalos para una cadena cuando proceda

Propiedad	Value
Identificador de la regla	CA1831
Título	Usar AsSpan en lugar de indizadores basados en intervalos para una cadena cuando proceda
Categoría	Rendimiento
La corrección es problemática o no problemática	Poco problemático
Habilitado de forma predeterminada en .NET 8	Como advertencia

Causa

Un indizador de intervalo se usa en una cadena y el valor se asigna implícitamente a ReadOnlySpan<char>.

Descripción de la regla

Esta regla se desencadena cuando se usa un indizador de intervalo en una cadena y se asigna a un tipo de intervalo. El indizador de intervalo en un Span<T> es una operación Slice de no copia, pero para el indizador de intervalo en una cadena, se usará el método Substring en lugar de Slice. Esto produce una copia de la parte solicitada de la cadena. 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 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

Conversión implícita:

ReadOnlySpan<char> slice = str[a..b];

No detecta

Conversión explícita:

ReadOnlySpan<char> slice = (ReadOnlySpan<char>)str[a..b];

Cómo corregir infracciones

Para corregir una infracción de esta regla, use AsSpan en lugar del indizador basado en Range en la cadena para evitar la creación de copias de datos innecesarias.

public void TestMethod(string str)
{
    // The violation occurs
    ReadOnlySpan<char> slice = str[1..3];
    ...
}

public void TestMethod(string str)
{
    // The violation fixed with AsSpan extension method
    ReadOnlySpan<char> slice = str.AsSpan()[1..3];
    ...
}

Sugerencia

Hay disponible una corrección de código para esta regla en Visual Studio. Para usarlo, coloque el cursor sobre la infracción y presione Ctrl+. (punto). Elija Use AsSpan instead of the Range-based indexer on a string (Usar AsSpan en lugar de indizadores basados en intervalos para una cadena) en la lista de opciones que se muestra.

También puede agregar una conversión explícita para evitar esta advertencia.

public void TestMethod(string str)
{
    // The violation occurs.
    ReadOnlySpan<char> slice = str[1..3];
    ...
}

public void TestMethod(string str)
{
    // The violation avoided with explicit casting.
    ReadOnlySpan<char> slice = (ReadOnlySpan<char>)str[1..3];
    ...
}

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 CA1831
// The code that's violating the rule is on this line.
#pragma warning restore CA1831

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.CA1831.severity = none

Para deshabilitar toda esta categoría de reglas, establezca la gravedad de la categoría en none del archivo de configuración.

[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Performance.severity = none

Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.

Reglas relacionadas

• CA1832: Usar AsSpan o AsMemory en lugar de indizadores basados en intervalos para obtener la parte ReadOnlySpan o ReadOnlyMemory de una matriz
• CA1833: Usar AsSpan o AsMemory en lugar de indizadores basados en intervalos para obtener la parte Span o Memory de una matriz

Vea también

• Reglas de rendimiento