forked from rust-lang/rust
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rollup merge of rust-lang#116597 - GuillaumeGomez:foreign-blanket-impl, r=notriddle Prevent showing methods from blanket impls of not available foreign traits to show up in the search results Fixes rust-lang#115480. In the case that the blanket impl trait is not available in the current crate, we prevent adding its methods in the search index. Now how I found how to fix the issue: the `equivalent` method is not generated in the documentation pages but was still added to the search index. To render impls, we iterate over `cache.impls` so I took a look at how this was generated. Inside `formats/cache.rs`, we have `CacheBuilder::populate` where we push impls into `impls` but with this condition: ```rust if cx.cache.traits.contains_key(&trait_did) { ``` I re-used this condition in `CacheBuilder::fold_item` to prevent this method from being added in `cache.search_index` or `cache.orphan_impl_items`. PS: If you want to double-check if the added test works, just comment the code I added in `cache.rs` and it should fail. r? ``@notriddle``
- Loading branch information
Showing
4 changed files
with
41 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
use std::borrow::Borrow; | ||
|
||
pub trait Equivalent<K: ?Sized> { | ||
fn equivalent(&self, key: &K) -> bool; | ||
} | ||
|
||
impl<Q: ?Sized, K: ?Sized> Equivalent<K> for Q | ||
where | ||
Q: Eq, | ||
K: Borrow<Q>, | ||
{ | ||
fn equivalent(&self, key: &K) -> bool { | ||
PartialEq::eq(self, key.borrow()) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
// exact-check | ||
|
||
// This test ensures that methods from blanket impls of not available foreign traits | ||
// don't show up in the search results. | ||
|
||
const EXPECTED = { | ||
'query': 'equivalent', | ||
'others': [], | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
// aux-crate:priv:equivalent=equivalent.rs | ||
// compile-flags: -Zunstable-options --extern equivalent | ||
// edition:2018 | ||
|
||
extern crate equivalent; | ||
|
||
#[derive(Clone, PartialEq, Eq, Debug)] | ||
pub struct LayoutError; |