Skip to content
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.

Sign up for GitHub

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

Jump to bottom

rustdoc: Start cleaning up search index generation #92340

Merged
merged 8 commits into from
Dec 29, 2021
Merged

rustdoc: Start cleaning up search index generation #92340

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
60a1abe
Rename `rustdoc::html::render::cache` to `search_index`
camelid Dec 28, 2021
e19593f
rustdoc: Remove some unnecessary `cache` parameters
camelid Dec 28, 2021
2b801dc
Move `ExternalLocation` to `clean::types`
camelid Dec 28, 2021
bd6692c
Make `search_index` functions private where possible
camelid Dec 28, 2021
afb77a9
Coalesce two arguments as `&Function`
camelid Dec 28, 2021
5c8e8e5
Give clearer names to several search index functions
camelid Dec 28, 2021
7d1ec64
Remove unused parameter
camelid Dec 28, 2021
908a9d4
Add regression test for #59502
camelid Dec 28, 2021
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
14 changes: 8 additions & 6 deletions src/librustdoc/html/render/search_index.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use rustc_span::symbol::Symbol;
use serde::ser::{Serialize, SerializeStruct, Serializer};

use crate::clean;
use crate::clean::types::{FnDecl, FnRetTy, GenericBound, Generics, Type, WherePredicate};
use crate::clean::types::{FnRetTy, Function, GenericBound, Generics, Type, WherePredicate};
use crate::formats::cache::Cache;
use crate::formats::item_type::ItemType;
use crate::html::markdown::short_markdown_summary;
Expand Down Expand Up @@ -186,9 +186,9 @@ crate fn get_index_search_type<'tcx>(
tcx: TyCtxt<'tcx>,
) -> Option<IndexItemFunctionType> {
let (mut inputs, mut output) = match *item.kind {
clean::FunctionItem(ref f) => get_all_types(&f.generics, &f.decl, tcx),
clean::MethodItem(ref m, _) => get_all_types(&m.generics, &m.decl, tcx),
clean::TyMethodItem(ref m) => get_all_types(&m.generics, &m.decl, tcx),
clean::FunctionItem(ref f) => get_all_types(f, tcx),
clean::MethodItem(ref m, _) => get_all_types(m, tcx),
clean::TyMethodItem(ref m) => get_all_types(m, tcx),
_ => return None,
};

Expand Down Expand Up @@ -378,10 +378,12 @@ fn get_real_types<'tcx>(
/// i.e. `fn foo<A: Display, B: Option<A>>(x: u32, y: B)` will return
/// `[u32, Display, Option]`.
fn get_all_types<'tcx>(
generics: &Generics,
decl: &FnDecl,
func: &Function,
Copy link
Member

Choose a reason for hiding this comment

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

Nice!

tcx: TyCtxt<'tcx>,
) -> (Vec<TypeWithKind>, Vec<TypeWithKind>) {
let decl = &func.decl;
let generics = &func.generics;

let mut all_types = Vec::new();
for arg in decl.inputs.values.iter() {
if arg.type_.is_self_type() {
Expand Down