Skip to content

rustdoc: function signature search with traits in where clause #108723

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
merged 1 commit into from
Mar 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 13 additions & 21 deletions src/librustdoc/html/render/search_index.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ use rustc_span::symbol::Symbol;
use serde::ser::{Serialize, SerializeStruct, Serializer};

use crate::clean;
use crate::clean::types::{
FnRetTy, Function, GenericBound, Generics, ItemId, Type, WherePredicate,
};
use crate::clean::types::{FnRetTy, Function, Generics, ItemId, Type, WherePredicate};
use crate::formats::cache::{Cache, OrphanImplItem};
use crate::formats::item_type::ItemType;
use crate::html::format::join_with_double_colon;
Expand Down Expand Up @@ -482,29 +480,23 @@ fn add_generics_and_bounds_as_types<'tcx, 'a>(
if let Type::Generic(arg_s) = *arg {
// First we check if the bounds are in a `where` predicate...
if let Some(where_pred) = generics.where_predicates.iter().find(|g| match g {
WherePredicate::BoundPredicate { ty, .. } => ty.def_id(cache) == arg.def_id(cache),
WherePredicate::BoundPredicate { ty: Type::Generic(ty_s), .. } => *ty_s == arg_s,
_ => false,
}) {
let mut ty_generics = Vec::new();
let bounds = where_pred.get_bounds().unwrap_or_else(|| &[]);
for bound in bounds.iter() {
if let GenericBound::TraitBound(poly_trait, _) = bound {
for param_def in poly_trait.generic_params.iter() {
match &param_def.kind {
clean::GenericParamDefKind::Type { default: Some(ty), .. } => {
add_generics_and_bounds_as_types(
self_,
generics,
ty,
tcx,
recurse + 1,
&mut ty_generics,
cache,
)
}
_ => {}
}
}
if let Some(path) = bound.get_trait_path() {
let ty = Type::Path { path };
add_generics_and_bounds_as_types(
self_,
generics,
&ty,
tcx,
recurse + 1,
&mut ty_generics,
cache,
);
}
}
insert_ty(res, arg.clone(), ty_generics);
Expand Down
7 changes: 7 additions & 0 deletions tests/rustdoc-js-std/option-type-signatures.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
const QUERY = 'option, fnonce -> option';

const EXPECTED = {
'others': [
{ 'path': 'std::option::Option', 'name': 'map' },
],
};
19 changes: 19 additions & 0 deletions tests/rustdoc-js/where-clause.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
const QUERY = ['trait<nested>', '-> trait<nested>', 't1, t2'];

const EXPECTED = [
{
'in_args': [
{ 'path': 'where_clause', 'name': 'abracadabra' },
],
},
{
'others': [
{ 'path': 'where_clause', 'name': 'alacazam' },
],
},
{
'others': [
{ 'path': 'where_clause', 'name': 'presto' },
],
},
];
16 changes: 16 additions & 0 deletions tests/rustdoc-js/where-clause.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
pub struct Nested;

pub trait Trait<T> {
fn thank_you(x: T);
}

pub fn abracadabra<X>(_: X) where X: Trait<Nested> {}

pub fn alacazam<X>() -> X where X: Trait<Nested> {}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pokemon reference? 🤣


pub trait T1 {}
pub trait T2<'a, T> {
fn please(_: &'a T);
}

pub fn presto<A, B>(_: A, _: B) where A: T1, B: for <'b> T2<'b, Nested> {}