about summary refs log tree commit diff
diff options
context:
space:
mode:
authornzrq <42440961+nzrq@users.noreply.github.com>2022-06-03 13:05:57 -0400
committerGitHub <noreply@github.com>2022-06-03 13:05:57 -0400
commit2ea9e04bf71e85746453b26d3bebe4d0400b7421 (patch)
tree2d2bb36a72eca27bf6526c6adfb12cb48e62a612
parente40d5e83dc133d093c22c7ff016b10daa4f40dcf (diff)
downloadrust-2ea9e04bf71e85746453b26d3bebe4d0400b7421.tar.gz
rust-2ea9e04bf71e85746453b26d3bebe4d0400b7421.zip
Add note to documentation of HashSet::intersection
-rw-r--r--library/std/src/collections/hash/set.rs7
1 files changed, 7 insertions, 0 deletions
diff --git a/library/std/src/collections/hash/set.rs b/library/std/src/collections/hash/set.rs
index 19428fe9a23..6ca4b7fa2d9 100644
--- a/library/std/src/collections/hash/set.rs
+++ b/library/std/src/collections/hash/set.rs
@@ -588,6 +588,13 @@ where
     /// Visits the values representing the intersection,
     /// i.e., the values that are both in `self` and `other`.
     ///
+    /// Note: this operation does not guarantee which collection
+    /// is visited from `self` or `other`. This has consequences
+    /// for values which may be defined as equal by the `Eq` trait
+    /// but which are not physically equivalent (eg. they may have
+    /// fields which differ or do not participate in the definition
+    /// of equivalence).
+    ///
     /// # Examples
     ///
     /// ```