-
Notifications
You must be signed in to change notification settings - Fork 13.4k
for purely return-type based searches, deprioritize clone-like functions #135302
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
bors
merged 1 commit into
rust-lang:master
from
lolbinarycat:rustdoc-search-return-sort-134935
Jan 15, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
---|---|---|
|
@@ -2717,9 +2717,26 @@ class DocSearch { | |
const normalizedUserQuery = parsedQuery.userQuery.toLowerCase(); | ||
const isMixedCase = normalizedUserQuery !== userQuery; | ||
const result_list = []; | ||
const isReturnTypeQuery = parsedQuery.elems.length === 0 || | ||
typeInfo === "returned"; | ||
for (const result of results.values()) { | ||
result.item = this.searchIndex[result.id]; | ||
result.word = this.searchIndex[result.id].word; | ||
if (isReturnTypeQuery) { | ||
// we are doing a return-type based search, | ||
// deprioritize "clone-like" results, | ||
// ie. functions that also take the queried type as an argument. | ||
const hasType = result.item && result.item.type; | ||
if (!hasType) { | ||
continue; | ||
} | ||
const inputs = result.item.type.inputs; | ||
const where_clause = result.item.type.where_clause; | ||
if (containsTypeFromQuery(inputs, where_clause)) { | ||
result.path_dist *= 100; | ||
result.dist *= 100; | ||
} | ||
} | ||
result_list.push(result); | ||
} | ||
|
||
|
@@ -3540,6 +3557,35 @@ class DocSearch { | |
return false; | ||
} | ||
|
||
/** | ||
* This function checks if the given list contains any | ||
* (non-generic) types mentioned in the query. | ||
* | ||
* @param {Array<FunctionType>} list - A list of function types. | ||
* @param {[FunctionType]} where_clause - Trait bounds for generic items. | ||
*/ | ||
function containsTypeFromQuery(list, where_clause) { | ||
if (!list) return false; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please add parens (here an below) for coherency with the rest of the code. |
||
for (const ty of parsedQuery.returned) { | ||
// negative type ids are generics | ||
if (ty.id < 0) { | ||
continue; | ||
} | ||
if (checkIfInList(list, ty, where_clause, null, 0)) { | ||
return true; | ||
} | ||
} | ||
for (const ty of parsedQuery.elems) { | ||
if (ty.id < 0) { | ||
continue; | ||
} | ||
if (checkIfInList(list, ty, where_clause, null, 0)) { | ||
return true; | ||
} | ||
} | ||
return false; | ||
} | ||
|
||
/** | ||
* This function checks if the object (`row`) matches the given type (`elem`) and its | ||
* generics (if any). | ||
|
This file contains hidden or 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,30 @@ | ||
// test that `clone`-like functions are sorted lower when | ||
// a search is based soley on return type | ||
|
||
const FILTER_CRATE = "core"; | ||
|
||
const EXPECTED = [ | ||
{ | ||
'query': '-> AllocError', | ||
'others': [ | ||
{ 'path': 'core::alloc::Allocator', 'name': 'allocate' }, | ||
{ 'path': 'core::alloc::AllocError', 'name': 'clone' }, | ||
], | ||
}, | ||
{ | ||
'query': 'AllocError', | ||
'returned': [ | ||
{ 'path': 'core::alloc::Allocator', 'name': 'allocate' }, | ||
{ 'path': 'core::alloc::AllocError', 'name': 'clone' }, | ||
], | ||
}, | ||
{ | ||
'query': '-> &str', | ||
'others': [ | ||
// type_name_of_val should not be consider clone-like | ||
{ 'path': 'core::any', 'name': 'type_name_of_val' }, | ||
// this returns `Option<&str>`, and thus should be sorted lower | ||
{ 'path': 'core::str::Split', 'name': 'next' }, | ||
], | ||
}, | ||
] |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.