rustdoc: Hide methods from #[doc(masked)] crates from the search index
This commit is contained in:
parent
fdc18b3067
commit
2e81ce7dfa
3 changed files with 87 additions and 25 deletions
|
@ -1174,6 +1174,16 @@ impl DocFolder for Cache {
|
||||||
_ => self.stripped_mod,
|
_ => self.stripped_mod,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// If the impl is from a masked crate or references something from a
|
||||||
|
// masked crate then remove it completely.
|
||||||
|
if let clean::ImplItem(ref i) = item.inner {
|
||||||
|
if self.masked_crates.contains(&item.def_id.krate) ||
|
||||||
|
i.trait_.def_id().map_or(false, |d| self.masked_crates.contains(&d.krate)) ||
|
||||||
|
i.for_.def_id().map_or(false, |d| self.masked_crates.contains(&d.krate)) {
|
||||||
|
return None;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Register any generics to their corresponding string. This is used
|
// Register any generics to their corresponding string. This is used
|
||||||
// when pretty-printing types.
|
// when pretty-printing types.
|
||||||
if let Some(generics) = item.inner.generics() {
|
if let Some(generics) = item.inner.generics() {
|
||||||
|
@ -1188,16 +1198,12 @@ impl DocFolder for Cache {
|
||||||
|
|
||||||
// Collect all the implementors of traits.
|
// Collect all the implementors of traits.
|
||||||
if let clean::ImplItem(ref i) = item.inner {
|
if let clean::ImplItem(ref i) = item.inner {
|
||||||
if !self.masked_crates.contains(&item.def_id.krate) {
|
|
||||||
if let Some(did) = i.trait_.def_id() {
|
if let Some(did) = i.trait_.def_id() {
|
||||||
if i.for_.def_id().map_or(true, |d| !self.masked_crates.contains(&d.krate)) {
|
|
||||||
self.implementors.entry(did).or_insert(vec![]).push(Impl {
|
self.implementors.entry(did).or_insert(vec![]).push(Impl {
|
||||||
impl_item: item.clone(),
|
impl_item: item.clone(),
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Index this method for searching later on.
|
// Index this method for searching later on.
|
||||||
if let Some(ref s) = item.name {
|
if let Some(ref s) = item.name {
|
||||||
|
@ -1358,9 +1364,6 @@ impl DocFolder for Cache {
|
||||||
// Note: matching twice to restrict the lifetime of the `i` borrow.
|
// Note: matching twice to restrict the lifetime of the `i` borrow.
|
||||||
let mut dids = FxHashSet();
|
let mut dids = FxHashSet();
|
||||||
if let clean::Item { inner: clean::ImplItem(ref i), .. } = item {
|
if let clean::Item { inner: clean::ImplItem(ref i), .. } = item {
|
||||||
let masked_trait = i.trait_.def_id().map_or(false,
|
|
||||||
|d| self.masked_crates.contains(&d.krate));
|
|
||||||
if !masked_trait {
|
|
||||||
match i.for_ {
|
match i.for_ {
|
||||||
clean::ResolvedPath { did, .. } |
|
clean::ResolvedPath { did, .. } |
|
||||||
clean::BorrowedRef {
|
clean::BorrowedRef {
|
||||||
|
@ -1378,7 +1381,6 @@ impl DocFolder for Cache {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
if let Some(generics) = i.trait_.as_ref().and_then(|t| t.generics()) {
|
if let Some(generics) = i.trait_.as_ref().and_then(|t| t.generics()) {
|
||||||
for bound in generics {
|
for bound in generics {
|
||||||
|
|
20
src/test/rustdoc/auxiliary/masked.rs
Normal file
20
src/test/rustdoc/auxiliary/masked.rs
Normal file
|
@ -0,0 +1,20 @@
|
||||||
|
// Copyright 2018 The Rust Project Developers. See the COPYRIGHT
|
||||||
|
// file at the top-level directory of this distribution and at
|
||||||
|
// http://rust-lang.org/COPYRIGHT.
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
||||||
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
||||||
|
// option. This file may not be copied, modified, or distributed
|
||||||
|
// except according to those terms.
|
||||||
|
|
||||||
|
#[derive(Clone)]
|
||||||
|
pub struct MaskedStruct;
|
||||||
|
|
||||||
|
pub trait MaskedTrait {
|
||||||
|
fn masked_method();
|
||||||
|
}
|
||||||
|
|
||||||
|
impl MaskedTrait for String {
|
||||||
|
fn masked_method() {}
|
||||||
|
}
|
40
src/test/rustdoc/masked.rs
Normal file
40
src/test/rustdoc/masked.rs
Normal file
|
@ -0,0 +1,40 @@
|
||||||
|
// Copyright 2018 The Rust Project Developers. See the COPYRIGHT
|
||||||
|
// file at the top-level directory of this distribution and at
|
||||||
|
// http://rust-lang.org/COPYRIGHT.
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
||||||
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
||||||
|
// option. This file may not be copied, modified, or distributed
|
||||||
|
// except according to those terms.
|
||||||
|
|
||||||
|
// aux-build:masked.rs
|
||||||
|
|
||||||
|
#![feature(doc_masked)]
|
||||||
|
|
||||||
|
#![crate_name = "foo"]
|
||||||
|
|
||||||
|
#[doc(masked)]
|
||||||
|
extern crate masked;
|
||||||
|
|
||||||
|
// @!has 'search-index.js' 'masked_method'
|
||||||
|
|
||||||
|
// @!has 'foo/struct.String.html' 'MaskedTrait'
|
||||||
|
// @!has 'foo/struct.String.html' 'masked_method'
|
||||||
|
pub use std::string::String;
|
||||||
|
|
||||||
|
// @!has 'foo/trait.Clone.html' 'MaskedStruct'
|
||||||
|
pub use std::clone::Clone;
|
||||||
|
|
||||||
|
// @!has 'foo/struct.MyStruct.html' 'MaskedTrait'
|
||||||
|
// @!has 'foo/struct.MyStruct.html' 'masked_method'
|
||||||
|
pub struct MyStruct;
|
||||||
|
|
||||||
|
impl masked::MaskedTrait for MyStruct {
|
||||||
|
fn masked_method() {}
|
||||||
|
}
|
||||||
|
|
||||||
|
// @!has 'foo/trait.MyTrait.html' 'MaskedStruct'
|
||||||
|
pub trait MyTrait {}
|
||||||
|
|
||||||
|
impl MyTrait for masked::MaskedStruct {}
|
Loading…
Add table
Add a link
Reference in a new issue