rustdoc: Also index `impl Trait`s and raw pointers #92339

camelid · 2021-12-28T03:39:25Z

dyn Traits and references are indexed, so these should be as well.

src/librustdoc/html/render/cache.rs

camelid · 2021-12-28T03:41:35Z

src/librustdoc/html/render/cache.rs

@@ -226,18 +226,25 @@ fn get_index_type_name(clean_type: &clean::Type, accept_generic: bool) -> Option
            let path = &bounds[0].trait_;
            Some(path.segments.last().unwrap().name)
        }
+        clean::ImplTrait(ref bounds) => {
+            let first_trait = bounds.iter().find_map(|b| match b {
+                clean::GenericBound::TraitBound(poly_trait, _) => Some(&poly_trait.trait_),


Note that this will always pick the first trait bound, even if it's ?Sized or ~const Drop.

It should return all traits, not just the first one. I have no idea what ~const Drop means and can't find it on the internet... If it's like !Drop, we shouldn't list it. For ?Sized, I'm not sure if we should list it or not...

I agree, though note that the pre-existing code only returns the first trait of a dyn Trait1 + Trait2 + ... type. Making it return all traits would be a bigger change; would you like me to attempt that here?

~const Drop: #67792

Making it return all traits would be a bigger change; would you like me to attempt that here?

Yes please!

camelid · 2021-12-28T21:59:49Z

~~Blocked on #92340.~~ Merged now.

`dyn Trait`s and references are indexed, so these should be as well.

camelid · 2021-12-29T23:46:29Z

src/librustdoc/html/render/mod.rs

-    name: Option<String>,
-    generics: Option<Vec<TypeWithKind>>,
+    name: String,
+    generics: Vec<TypeWithKind>,


Can this and similar refactorings have any effect on behavior? I found it quite bizarre that the search-index representation of a type can exist without a name.

It's possible in case you have something like T: Display + Whatever. In this case, since T isn't a type, we don't keep its name. Please revert this change.

This change didn't cause any tests to fail though. Could you please write a test case that passes on master and fails with this refactoring? Otherwise it'll be hard to not break this code accidentally.

Please add one then. Something like (in rustdoc-js):

pub fn foo<Something: Debug>(s: Something) {}

Then look for Something. You shouldn't have any result.

camelid · 2022-01-04T03:35:56Z

Ready for review!

camelid · 2022-01-04T03:45:32Z

The last two commits are not necessary for this PR. I tacked them on since they're fairly small and self-contained. Let me know if you'd like me to split them into another PR.

camelid · 2022-01-25T20:11:37Z

@GuillaumeGomez could you please review this sometime soon? :)

notriddle · 2022-01-26T15:59:00Z

src/librustdoc/html/render/search_index.rs

        if is_full_generic {
            // We remove the name of the full generic because we have no use for it.
-            index_ty.name = Some(String::new());


@GuillaumeGomez

It seems like, in the multi-generic case you were worried about, the old code didn't actually set the value to None. It actually slided the empty string into there instead.

On the one hand, this means we can get rid of the Option wrapper without breaking anything. On the other hand, this is really strange code.

@camelid

For the record, I approve of this refactoring. If the generated JSON uses the empty string as its sentinel here (and it should, because it's smaller), then RenderType should just use the empty string here to match.

My point here is that the old code, which uses Some(""), is very strange. It even seemed to confuse its original author!

There is another open PR which fixes this part but can't find it... T_T

rust-lang#92339 (comment)

…ulti-trait, r=GuillaumeGomez rustdoc: add test case for multiple traits and erased names rust-lang#92339 (comment)

bors · 2022-01-30T23:58:17Z

☔ The latest upstream changes (presumably #92711) made this pull request unmergeable. Please resolve the merge conflicts.

…uillaumeGomez rustdoc: also index impl trait and raw pointers Revives rust-lang#92339

notriddle · 2022-08-24T01:31:09Z

This is obsoleted by #97592, right?

camelid · 2022-08-26T02:58:13Z

Ah, I didn't see that PR! Thanks for reviving it :)

camelid added the A-rustdoc-search Area: Rustdoc's search feature label Dec 28, 2021

rust-highfive assigned GuillaumeGomez Dec 28, 2021

rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Dec 28, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 28, 2021

camelid commented Dec 28, 2021

View reviewed changes

src/librustdoc/html/render/cache.rs Outdated Show resolved Hide resolved

camelid commented Dec 28, 2021

View reviewed changes

camelid added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 28, 2021

camelid force-pushed the also-index branch from 1de6ad3 to 6db9a52 Compare December 28, 2021 21:59

camelid marked this pull request as draft December 28, 2021 21:59

This comment has been minimized.

Sign in to view

camelid force-pushed the also-index branch from 6db9a52 to 691990b Compare December 29, 2021 01:16

camelid added 2 commits December 29, 2021 15:44

rustdoc: Also index impl Traits and raw pointers

8f5a308

`dyn Trait`s and references are indexed, so these should be as well.

Refactor search-index types to avoid Options

283c71e

camelid force-pushed the also-index branch from 691990b to 283c71e Compare December 29, 2021 23:44

camelid commented Dec 29, 2021

View reviewed changes

search-index: Yield all trait bounds, not just the first

f27ed72

camelid added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jan 4, 2022

camelid added 2 commits January 3, 2022 19:39

Make some clones explicit

1186c15

Clean up some code to make it simpler

e7222b9

camelid marked this pull request as ready for review January 4, 2022 03:44

JohnCSimon added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 23, 2022

notriddle reviewed Jan 26, 2022

View reviewed changes

notriddle mentioned this pull request Jan 26, 2022

rustdoc: add test case for multiple traits and erased names #93339

Merged

notriddle added a commit to notriddle/rust that referenced this pull request Jan 26, 2022

rustdoc: add test case for multiple traits and erased names

f5cdfb4

rust-lang#92339 (comment)

camelid added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Jan 31, 2022

JohnCSimon added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Feb 27, 2022

camelid mentioned this pull request May 4, 2022

rustdoc: include impl generics / self in search index #96652

Merged

notriddle mentioned this pull request May 31, 2022

rustdoc: also index impl trait and raw pointers #97592

Merged

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jun 1, 2022

Rollup merge of rust-lang#97592 - notriddle:notriddle/impl-trait, r=G…

16ffd83

…uillaumeGomez rustdoc: also index impl trait and raw pointers Revives rust-lang#92339

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jun 1, 2022

Rollup merge of rust-lang#97592 - notriddle:notriddle/impl-trait, r=G…

1730b62

…uillaumeGomez rustdoc: also index impl trait and raw pointers Revives rust-lang#92339

notriddle closed this Aug 24, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rustdoc: Also index `impl Trait`s and raw pointers #92339

rustdoc: Also index `impl Trait`s and raw pointers #92339

camelid commented Dec 28, 2021

camelid Dec 28, 2021

GuillaumeGomez Dec 28, 2021 •

edited

Loading

camelid Dec 28, 2021

GuillaumeGomez Dec 28, 2021

camelid Jan 4, 2022

camelid commented Dec 28, 2021 •

edited

Loading

This comment has been minimized.

camelid Dec 29, 2021

GuillaumeGomez Jan 6, 2022

camelid Jan 7, 2022 •

edited

Loading

GuillaumeGomez Jan 26, 2022

notriddle Jan 26, 2022

camelid commented Jan 4, 2022

camelid commented Jan 4, 2022 •

edited

Loading

camelid commented Jan 25, 2022

notriddle Jan 26, 2022

notriddle Jan 26, 2022 •

edited

Loading

GuillaumeGomez Jan 26, 2022

bors commented Jan 30, 2022

notriddle commented Aug 24, 2022

camelid commented Aug 26, 2022

rustdoc: Also index impl Traits and raw pointers #92339

rustdoc: Also index impl Traits and raw pointers #92339

Conversation

camelid commented Dec 28, 2021

Choose a reason for hiding this comment

GuillaumeGomez Dec 28, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camelid commented Dec 28, 2021 • edited Loading

This comment has been minimized.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camelid Jan 7, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camelid commented Jan 4, 2022

camelid commented Jan 4, 2022 • edited Loading

camelid commented Jan 25, 2022

Choose a reason for hiding this comment

notriddle Jan 26, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bors commented Jan 30, 2022

notriddle commented Aug 24, 2022

camelid commented Aug 26, 2022

rustdoc: Also index `impl Trait`s and raw pointers #92339

rustdoc: Also index `impl Trait`s and raw pointers #92339

GuillaumeGomez Dec 28, 2021 •

edited

Loading

camelid commented Dec 28, 2021 •

edited

Loading

camelid Jan 7, 2022 •

edited

Loading

camelid commented Jan 4, 2022 •

edited

Loading

notriddle Jan 26, 2022 •

edited

Loading