CA1517: Usar ReadOnlySpan<T> o ReadOnlyMemory<T> en lugar de Span<T> o Memory<T>

Property Value
ID de regla CA1517
Title Usar ReadOnlySpan<T> o ReadOnlyMemory<T> en lugar de Span<T> o Memory<T>
Categoría Mantenibilidad
La corrección es incompatible o no incompatible Non-breaking
Habilitado de forma predeterminada en .NET 10 No
Habilitado de forma predeterminada en .NET 11 Como sugerencia
Idiomas aplicables C#

Cause

Un método tiene un parámetro Span<T> o Memory<T> que no modifica.

Descripción de la regla

Use ReadOnlySpan<T> o ReadOnlyMemory<T> para los datos que un método solo lee. El tipo de solo lectura hace que la intención del método sea clara y permite a quienes llaman al método pasar datos que no pueden modificar.

Cómo corregir infracciones

Cambie el tipo de parámetro a su homólogo de solo lectura. El analizador no notifica métodos que no pueden cambiar de forma segura su tipo de parámetro, como métodos virtuales o de interfaz.

Examples

El código siguiente muestra una infracción de CA1517:

static int GetFirst(Span<int> values) => values[0];

Cambiar Span<T> a ReadOnlySpan<T>:

static int GetFirst(ReadOnlySpan<int> values) => values[0];

Para los parámetros Memory<T>, use ReadOnlyMemory<T> en su lugar.

Cuándo suprimir las advertencias

Suprima la advertencia solo cuando el método debe exponer un parámetro grabable, aunque su implementación actual no modifique los datos.

Supresión de una advertencia

Para suprimir una sola infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y, a continuación, volver a habilitar la regla.

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

Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad a none en el archivo de configuración.

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

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

Consulte también