forked from rust-lang/rust
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rollup merge of rust-lang#124939 - Urgau:hide-private-fields-aliased-type, r=GuillaumeGomez Always hide private fields in aliased type This PR adds a new rustdoc pass that unconditionally always strips all private fields in aliased type, since showing them, even with `--document-private-items`, is confusing, unhelpful, and run backwards to the "Aliased type" feature, which is to show the type as it would be seen by the user. r? ```@GuillaumeGomez``` Fixes rust-lang#124938 Fixes rust-lang#123860
- Loading branch information
Showing
5 changed files
with
84 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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,57 @@ | ||
use rustc_middle::ty::TyCtxt; | ||
use rustc_middle::ty::Visibility; | ||
|
||
use crate::clean; | ||
use crate::clean::Item; | ||
use crate::core::DocContext; | ||
use crate::fold::{strip_item, DocFolder}; | ||
use crate::passes::Pass; | ||
|
||
pub(crate) const STRIP_ALIASED_NON_LOCAL: Pass = Pass { | ||
name: "strip-aliased-non-local", | ||
run: strip_aliased_non_local, | ||
description: "strips all non-local private aliased items from the output", | ||
}; | ||
|
||
fn strip_aliased_non_local(krate: clean::Crate, cx: &mut DocContext<'_>) -> clean::Crate { | ||
let mut stripper = AliasedNonLocalStripper { tcx: cx.tcx }; | ||
stripper.fold_crate(krate) | ||
} | ||
|
||
struct AliasedNonLocalStripper<'tcx> { | ||
tcx: TyCtxt<'tcx>, | ||
} | ||
|
||
impl<'tcx> DocFolder for AliasedNonLocalStripper<'tcx> { | ||
fn fold_item(&mut self, i: Item) -> Option<Item> { | ||
Some(match *i.kind { | ||
clean::TypeAliasItem(..) => { | ||
let mut stripper = NonLocalStripper { tcx: self.tcx }; | ||
// don't call `fold_item` as that could strip the type-alias it-self | ||
// which we don't want to strip out | ||
stripper.fold_item_recur(i) | ||
} | ||
_ => self.fold_item_recur(i), | ||
}) | ||
} | ||
} | ||
|
||
struct NonLocalStripper<'tcx> { | ||
tcx: TyCtxt<'tcx>, | ||
} | ||
|
||
impl<'tcx> DocFolder for NonLocalStripper<'tcx> { | ||
fn fold_item(&mut self, i: Item) -> Option<Item> { | ||
// If not local, we want to respect the original visibility of | ||
// the field and not the one given by the user for the currrent crate. | ||
// | ||
// FIXME(#125009): Not-local should probably consider same Cargo workspace | ||
if !i.def_id().map_or(true, |did| did.is_local()) { | ||
if i.visibility(self.tcx) != Some(Visibility::Public) || i.is_doc_hidden() { | ||
return Some(strip_item(i)); | ||
} | ||
} | ||
|
||
Some(self.fold_item_recur(i)) | ||
} | ||
} |
This file contains 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
This file contains 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,11 @@ | ||
//! This test makes sure that with never show the inner fields in the | ||
//! aliased type view of type alias. | ||
|
||
//@ compile-flags: -Z unstable-options --document-private-items | ||
|
||
#![crate_name = "foo"] | ||
|
||
use std::collections::BTreeMap; | ||
|
||
// @has 'foo/type.FooBar.html' '//*[@class="rust item-decl"]/code' 'struct FooBar { /* private fields */ }' | ||
pub type FooBar = BTreeMap<u32, String>; |
This file contains 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,9 @@ | ||
//! This test makes sure that with never show the inner fields in the | ||
//! aliased type view of type alias. | ||
|
||
#![crate_name = "foo"] | ||
|
||
use std::collections::BTreeMap; | ||
|
||
// @has 'foo/type.FooBar.html' '//*[@class="rust item-decl"]/code' 'struct FooBar { /* private fields */ }' | ||
pub type FooBar = BTreeMap<u32, String>; |