[ADT] Deprecate StringRef::equals (#92351)

kazutakahirata · web-flow · commit de483ad51389 · 2024-05-16T00:38:37.000-07:00
This patch deprecates StringRef::equals.  Note that I've migrated all
known users to operator==(StringRef, StringRef).
diff --git a/llvm/include/llvm/ADT/StringRef.h b/llvm/include/llvm/ADT/StringRef.h
@@ -161,7 +161,8 @@ 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 == instead",
+                                  "==") bool equals(StringRef RHS) const {
       return (Length == RHS.Length &&
               compareMemory(Data, RHS.Data, RHS.Length) == 0);
     }

Original file line number	Diff line number	Diff line change
`@@ -161,7 +161,8 @@ namespace llvm {`
`161`	`161`
`162`	`162`	`/// equals - Check for string equality, this is more efficient than`
`163`	`163`	`/// compare() when the relative ordering of inequal strings isn't needed.`
`164`		`- [[nodiscard]] bool equals(StringRef RHS) const {`
	`164`	`+ [[nodiscard]] LLVM_DEPRECATED("Use == instead",`
	`165`	`+ "==") bool equals(StringRef RHS) const {`
`165`	`166`	`return (Length == RHS.Length &&`
`166`	`167`	`compareMemory(Data, RHS.Data, RHS.Length) == 0);`
`167`	`168`	`}`