CA1517: ReadOnlyMemory<T> または Memory<T> の代わりに Span<T> または ReadOnlySpan<T> を使用します

プロパティ Value
ルール ID CA1517
肩書き ReadOnlySpan<T>またはMemory<T>の代わりにSpan<T>またはReadOnlyMemory<T>を使用する
カテゴリ 保守性
修正が破壊的変更か非破壊的変更か Non-breaking
.NET 10 で既定で有効 No
.NET 11 で既定で有効 一つの提案として
該当する言語 C#

Cause

メソッドには、変更されない Span<T> または Memory<T> パラメーターがあります。

ルールの説明

メソッドが読み取り専用で使用するデータには、ReadOnlySpan<T> または ReadOnlyMemory<T> を使用します。 読み取り専用型では、メソッドの意図が明確になり、呼び出し元は変更できないデータを渡すことができます。

違反を修正する方法

パラメーターの型を、対応する読み取り専用の型に変更します。 アナライザーは、仮想メソッドやインターフェイス メソッドなど、パラメーターの種類を安全に変更できないメソッドを報告しません。

例示

次のコードは、CA1517 の違反を示しています。

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

Span<T> を ReadOnlySpan<T> に変更します。

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

Memory<T>パラメーターの場合は、代わりに ReadOnlyMemory<T> を使用します。

どのようなときに警告を抑制するか

現在の実装ではデータが変更されない場合でも、メソッドが書き込み可能なパラメーターを公開する必要がある場合にのみ、警告を抑制します。

警告を抑制する

1 つの違反を抑制するには、ソース ファイルにプリプロセッサ ディレクティブを追加して無効にしてから、ルールを再度有効にします。

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

ファイル、フォルダー、またはプロジェクトのルールを無効にするには、noneでその重要度をに設定します。

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

詳細については、「 コード分析の警告を抑制する方法」を参照してください。

参照