[ADT] Deprecate StringRef::equals

[kazutakahirata]

This patch deprecates StringRef::equals. Note that I've migrated all
known users to operator==(StringRef, StringRef).

[llvmbot]

@llvm/pr-subscribers-llvm-adt

Author: Kazu Hirata (kazutakahirata)

Changes

This patch deprecates StringRef::equals. Note that I've migrated all
known users to operator==(StringRef, StringRef).

---

Full diff: https://github.com/llvm/llvm-project/pull/92351.diff

1 Files Affected:

• (modified) llvm/include/llvm/ADT/StringRef.h (+3-1)

diff --git a/llvm/include/llvm/ADT/StringRef.h b/llvm/include/llvm/ADT/StringRef.h
index 8ed8e424cfe13..641de5dcef280 100644
--- a/llvm/include/llvm/ADT/StringRef.h
+++ b/llvm/include/llvm/ADT/StringRef.h
@@ -161,7 +161,9 @@ namespace llvm {
 
     /// equals - Check for string equality, this is more efficient than
     /// compare() when the relative ordering of inequal strings isn't needed.
-    [[nodiscard]] bool equals(StringRef RHS) const {
+    [[nodiscard]] LLVM_DEPRECATED(
+        "Use operator==(StringRef, StringRef) instead",
+        "==") bool equals(StringRef RHS) const {
       return (Length == RHS.Length &&
               compareMemory(Data, RHS.Data, RHS.Length) == 0);
     }