[rustdoc] Make aliases search support partial matching#143988

GuillaumeGomez · 2025-07-15T19:17:12Z

To make this work, I moved aliases into the searchIndex like any other item. It links to the "original" item with a new original field. No so great part is that we need to have some fields like bitIndex to be set on the alias to make the description load to work but I consider it minor enough to be ok.

This PR voluntarily doesn't handle de-prioritization of aliases as @lolbinarycat wished to work on this so I'll leave them this part. 😉

cc @lolbinarycat

rustbot · 2025-07-15T19:17:17Z

r? @notriddle

rustbot has assigned @notriddle.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

rustbot · 2025-07-15T19:17:20Z

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @jsha, @lolbinarycat

lolbinarycat · 2025-07-15T19:52:53Z

src/librustdoc/html/render/search_index.rs

    for (i, item) in cache.search_index.iter().enumerate() {
        for alias in &item.aliases[..] {
-            aliases.entry(alias.as_str().to_lowercase()).or_default().push(i);
+            aliases.entry(alias.to_string()).or_default().push(i);


Since there is no longer any transformation taking place, and since aliases doesn't seem to escape the function (based on the fact CrateData is a struct defined within this function and it borrows the aliases variable), couldn't aliases have its type changed to BTreeMap<&str, Vec<usize>> to save a bunch of allocations?

Problem is with serde and borrow checker here. If I use &str, we can't do:

let mut search_index = std::mem::take(&mut cache.search_index);

just below. Other solution would be to keep Symbol instead, but Serialize is not implemented on it, so not possible either. Fixing this would require a lot of code, so better keep it for later optimization.

Is this worth a FIXME comment or is this too small of an optimization?

I don't think it's worth it. Also I expect you will gove it a try soon enough. 😄

src/librustdoc/html/static/js/search.js

lolbinarycat

Reviewed everything except the changes to tester.js, only thing I can think of is putting a doc comment on Row.name to explain that it is the the name of the item or alias, since this does change its semantics, everything else looks pretty good.

src/librustdoc/html/static/js/search.js

GuillaumeGomez · 2025-07-19T21:20:12Z

Thanks for the review!

@bors r=lolbinarycat rollup

bors · 2025-07-19T21:20:15Z

📌 Commit 2f14d0a has been approved by lolbinarycat

It is now in the queue for this repository.

…lbinarycat [rustdoc] Make aliases search support partial matching Fixes rust-lang#140782. To make this work, I moved aliases into the `searchIndex` like any other item. It links to the "original" item with a new `original` field. No so great part is that we need to have some fields like `bitIndex` to be set on the alias to make the description load to work but I consider it minor enough to be ok. This PR voluntarily doesn't handle de-prioritization of aliases as `@lolbinarycat` wished to work on this so I'll leave them this part. 😉 cc `@lolbinarycat`

…lbinarycat [rustdoc] Make aliases search support partial matching Fixes rust-lang#140782. To make this work, I moved aliases into the `searchIndex` like any other item. It links to the "original" item with a new `original` field. No so great part is that we need to have some fields like `bitIndex` to be set on the alias to make the description load to work but I consider it minor enough to be ok. This PR voluntarily doesn't handle de-prioritization of aliases as ``@lolbinarycat`` wished to work on this so I'll leave them this part. 😉 cc ``@lolbinarycat``

Rollup of 12 pull requests Successful merges: - #141260 (Allow volatile access to non-Rust memory, including address 0) - #143604 (Stabilize `const_float_round_methods`) - #143833 (Ban projecting into SIMD types [MCP838]) - #143988 ([rustdoc] Make aliases search support partial matching) - #144078 (Fix debuginfo-lto-alloc.rs test) - #144111 (Remove deprecated `MaybeUninit` slice methods) - #144116 (Fixes for LLVM 21) - #144134 (Cleanup unicode table gen) - #144142 (Add implicit sized bound to trait ascription types) - #144148 (Remove pretty print hack for async blocks) - #144169 (interpret: fix TypeId pointers being considered data pointers) - #144196 (Initialize mingw for the runner's user) r? `@ghost` `@rustbot` modify labels: rollup

Rollup of 11 pull requests Successful merges: - #141260 (Allow volatile access to non-Rust memory, including address 0) - #143604 (Stabilize `const_float_round_methods`) - #143988 ([rustdoc] Make aliases search support partial matching) - #144078 (Fix debuginfo-lto-alloc.rs test) - #144111 (Remove deprecated `MaybeUninit` slice methods) - #144116 (Fixes for LLVM 21) - #144134 (Cleanup unicode table gen) - #144142 (Add implicit sized bound to trait ascription types) - #144148 (Remove pretty print hack for async blocks) - #144169 (interpret: fix TypeId pointers being considered data pointers) - #144196 (Initialize mingw for the runner's user) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of #143988 - GuillaumeGomez:alias-inexact, r=lolbinarycat [rustdoc] Make aliases search support partial matching Fixes #140782. To make this work, I moved aliases into the `searchIndex` like any other item. It links to the "original" item with a new `original` field. No so great part is that we need to have some fields like `bitIndex` to be set on the alias to make the description load to work but I consider it minor enough to be ok. This PR voluntarily doesn't handle de-prioritization of aliases as ```@lolbinarycat``` wished to work on this so I'll leave them this part. 😉 cc ```@lolbinarycat```

Rollup of 11 pull requests Successful merges: - rust-lang/rust#141260 (Allow volatile access to non-Rust memory, including address 0) - rust-lang/rust#143604 (Stabilize `const_float_round_methods`) - rust-lang/rust#143988 ([rustdoc] Make aliases search support partial matching) - rust-lang/rust#144078 (Fix debuginfo-lto-alloc.rs test) - rust-lang/rust#144111 (Remove deprecated `MaybeUninit` slice methods) - rust-lang/rust#144116 (Fixes for LLVM 21) - rust-lang/rust#144134 (Cleanup unicode table gen) - rust-lang/rust#144142 (Add implicit sized bound to trait ascription types) - rust-lang/rust#144148 (Remove pretty print hack for async blocks) - rust-lang/rust#144169 (interpret: fix TypeId pointers being considered data pointers) - rust-lang/rust#144196 (Initialize mingw for the runner's user) r? `@ghost` `@rustbot` modify labels: rollup

…lbinarycat [rustdoc] Make aliases search support partial matching Fixes rust-lang#140782. To make this work, I moved aliases into the `searchIndex` like any other item. It links to the "original" item with a new `original` field. No so great part is that we need to have some fields like `bitIndex` to be set on the alias to make the description load to work but I consider it minor enough to be ok. This PR voluntarily doesn't handle de-prioritization of aliases as ```@lolbinarycat``` wished to work on this so I'll leave them this part. 😉 cc ```@lolbinarycat```

…iaskrgr Rollup of 11 pull requests Successful merges: - rust-lang#141260 (Allow volatile access to non-Rust memory, including address 0) - rust-lang#143604 (Stabilize `const_float_round_methods`) - rust-lang#143988 ([rustdoc] Make aliases search support partial matching) - rust-lang#144078 (Fix debuginfo-lto-alloc.rs test) - rust-lang#144111 (Remove deprecated `MaybeUninit` slice methods) - rust-lang#144116 (Fixes for LLVM 21) - rust-lang#144134 (Cleanup unicode table gen) - rust-lang#144142 (Add implicit sized bound to trait ascription types) - rust-lang#144148 (Remove pretty print hack for async blocks) - rust-lang#144169 (interpret: fix TypeId pointers being considered data pointers) - rust-lang#144196 (Initialize mingw for the runner's user) r? `@ghost` `@rustbot` modify labels: rollup

…BTreeMap-str, r=GuillaumeGomez rustdoc: avoid allocating a temp String for aliases in search index Here's the optimization I talked about in rust-lang#143988 (comment) I got around the Serialize issue using the newtype pattern. The wrapper type could be factored out into a helper that would work with anything that impls `AsRef<&str>`, but I'm not sure if that would be helpful anywhere else. r? `@GuillaumeGomez`

…BTreeMap-str, r=GuillaumeGomez rustdoc: avoid allocating a temp String for aliases in search index Here's the optimization I talked about in rust-lang#143988 (comment) I got around the Serialize issue using the newtype pattern. The wrapper type could be factored out into a helper that would work with anything that impls `AsRef<&str>`, but I'm not sure if that would be helpful anywhere else. r? ``@GuillaumeGomez``

…BTreeMap-str, r=GuillaumeGomez rustdoc: avoid allocating a temp String for aliases in search index Here's the optimization I talked about in rust-lang#143988 (comment) I got around the Serialize issue using the newtype pattern. The wrapper type could be factored out into a helper that would work with anything that impls `AsRef<&str>`, but I'm not sure if that would be helpful anywhere else. r? ```@GuillaumeGomez```

…BTreeMap-str, r=GuillaumeGomez rustdoc: avoid allocating a temp String for aliases in search index Here's the optimization I talked about in rust-lang#143988 (comment) I got around the Serialize issue using the newtype pattern. The wrapper type could be factored out into a helper that would work with anything that impls `AsRef<&str>`, but I'm not sure if that would be helpful anywhere else. r? ````@GuillaumeGomez````

…BTreeMap-str, r=GuillaumeGomez rustdoc: avoid allocating a temp String for aliases in search index Here's the optimization I talked about in rust-lang#143988 (comment) I got around the Serialize issue using the newtype pattern. The wrapper type could be factored out into a helper that would work with anything that impls `AsRef<&str>`, but I'm not sure if that would be helpful anywhere else. r? `````@GuillaumeGomez`````

…BTreeMap-str, r=GuillaumeGomez rustdoc: avoid allocating a temp String for aliases in search index Here's the optimization I talked about in rust-lang#143988 (comment) I got around the Serialize issue using the newtype pattern. The wrapper type could be factored out into a helper that would work with anything that impls `AsRef<&str>`, but I'm not sure if that would be helpful anywhere else. r? ``````@GuillaumeGomez``````

Rollup merge of #144320 - lolbinarycat:rustdoc-search_index-BTreeMap-str, r=GuillaumeGomez rustdoc: avoid allocating a temp String for aliases in search index Here's the optimization I talked about in #143988 (comment) I got around the Serialize issue using the newtype pattern. The wrapper type could be factored out into a helper that would work with anything that impls `AsRef<&str>`, but I'm not sure if that would be helpful anywhere else. r? ``````@GuillaumeGomez``````

…r, r=lolbinarycat Rank doc aliases lower than equivalently matched items Follow-up of rust-lang#143988. cc `@lolbinarycat`

Rollup merge of #145100 - GuillaumeGomez:rank-doc-alias-lower, r=lolbinarycat Rank doc aliases lower than equivalently matched items Follow-up of #143988. cc `@lolbinarycat`

…inarycat Rank doc aliases lower than equivalently matched items Follow-up of rust-lang/rust#143988. cc `@lolbinarycat`

…r, r=lolbinarycat Rank doc aliases lower than equivalently matched items Follow-up of rust-lang#143988. cc `@lolbinarycat`

…inarycat Rank doc aliases lower than equivalently matched items Follow-up of rust-lang/rust#143988. cc `@lolbinarycat`

…str, r=GuillaumeGomez rustdoc: avoid allocating a temp String for aliases in search index Here's the optimization I talked about in rust-lang/rust#143988 (comment) I got around the Serialize issue using the newtype pattern. The wrapper type could be factored out into a helper that would work with anything that impls `AsRef<&str>`, but I'm not sure if that would be helpful anywhere else. r? ``````@GuillaumeGomez``````

…inarycat Rank doc aliases lower than equivalently matched items Follow-up of rust-lang/rust#143988. cc `@lolbinarycat`

rustbot assigned notriddle Jul 15, 2025

GuillaumeGomez mentioned this pull request Jul 15, 2025

rustdoc should include aliases in search that only partially matches #140782

Closed

lolbinarycat reviewed Jul 15, 2025

View reviewed changes

GuillaumeGomez added 3 commits July 16, 2025 14:27

Make aliases search support partial matching

47b138b

Update rustdoc search tester to new alias output

b0bf51f

Add test for aliases partial match

c079c96

GuillaumeGomez force-pushed the alias-inexact branch from 7c21fbf to c079c96 Compare July 16, 2025 12:27

lolbinarycat reviewed Jul 19, 2025

View reviewed changes

Add code comment explaining better what Row.name is for doc aliases

2f14d0a

lolbinarycat approved these changes Jul 19, 2025

View reviewed changes

src/librustdoc/html/static/js/search.js Show resolved Hide resolved

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 19, 2025

jhpratt mentioned this pull request Jul 20, 2025

Rollup of 13 pull requests #144202

Closed

fee1-dead mentioned this pull request Jul 20, 2025

Rollup of 12 pull requests #144204

Closed

matthiaskrgr mentioned this pull request Jul 20, 2025

Rollup of 11 pull requests #144208

Merged

bors merged commit dda5058 into rust-lang:master Jul 20, 2025
10 of 11 checks passed

rustbot added this to the 1.90.0 milestone Jul 20, 2025

GuillaumeGomez deleted the alias-inexact branch July 20, 2025 13:08

lolbinarycat mentioned this pull request Jul 22, 2025

rustdoc: avoid allocating a temp String for aliases in search index #144320

Merged

GuillaumeGomez mentioned this pull request Aug 8, 2025

Rank doc aliases lower than equivalently matched items #145100

Merged

Zalathar added a commit to Zalathar/rust that referenced this pull request Aug 9, 2025

Rollup merge of rust-lang#145100 - GuillaumeGomez:rank-doc-alias-lowe…

cd1e82a

…r, r=lolbinarycat Rank doc aliases lower than equivalently matched items Follow-up of rust-lang#143988. cc `@lolbinarycat`

rust-timer added a commit that referenced this pull request Aug 9, 2025

Unrolled build for #145100

862c248

Rollup merge of #145100 - GuillaumeGomez:rank-doc-alias-lower, r=lolbinarycat Rank doc aliases lower than equivalently matched items Follow-up of #143988. cc `@lolbinarycat`

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[rustdoc] Make aliases search support partial matching#143988