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.

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

Rollup of 7 pull requests #89262

Merged
merged 20 commits into from
Sep 26, 2021
Merged
Changes from 4 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
07d6454
Remove `Type::ResolvedPath.is_generic`
camelid Aug 23, 2021
1085dc2
Rename `is_generic()` to `is_assoc_ty()`
camelid Aug 31, 2021
52ab3e8
Add intra-doc-links to LinkedList rustdoc
est31 Sep 16, 2021
a8a829d
Add intra-doc-links to BinaryHeap rustdoc
est31 Sep 16, 2021
3727119
Add IntoIterator intra doc link to various collections
est31 Sep 16, 2021
956f87f
consistent big O notation
wooster0 Sep 24, 2021
353d637
change the order of path suggestions
TaKO8Ki Sep 24, 2021
4c23905
use `drain_filter` instead of `filter` and `retain`
TaKO8Ki Sep 25, 2021
3239f06
rustdoc: Don't show hidden trait methods
hkmatsumoto Sep 23, 2021
195f752
Elaborate comment
hkmatsumoto Sep 25, 2021
dace2ee
rustdoc: Document `is_assoc_ty()`
camelid Sep 25, 2021
160b939
Expose the std_detect env_override feature
lu-zero Sep 15, 2021
b51897f
Fix typo in release notes
dgiger42 Sep 25, 2021
7777f95
Rollup merge of #88895 - camelid:cleanup-pt2, r=jyn514
Manishearth Sep 26, 2021
f9d4eb0
Rollup merge of #88973 - lu-zero:std_detect-env_override, r=Amanieu
Manishearth Sep 26, 2021
b8c3a6c
Rollup merge of #89010 - est31:intra_doc_links, r=m-ou-se
Manishearth Sep 26, 2021
c118d8b
Rollup merge of #89198 - hkmatsumoto:hide-hidden-methods, r=jyn514
Manishearth Sep 26, 2021
653dcaa
Rollup merge of #89216 - r00ster91:bigo, r=dtolnay
Manishearth Sep 26, 2021
04d3f93
Rollup merge of #89224 - TaKO8Ki:change-the-order-of-suggestions, r=j…
Manishearth Sep 26, 2021
7d9a0e5
Rollup merge of #89256 - danielg1111:fix_typo, r=Mark-Simulacrum
Manishearth Sep 26, 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
15 changes: 3 additions & 12 deletions src/librustdoc/clean/auto_trait.rs
Original file line number Diff line number Diff line change
@@ -354,7 +354,7 @@ impl<'a, 'tcx> AutoTraitFinder<'a, 'tcx> {
let (poly_trait, output) =
(data.0.as_ref().unwrap().clone(), data.1.as_ref().cloned().map(Box::new));
let new_ty = match poly_trait.trait_ {
Type::ResolvedPath { ref path, ref did, ref is_generic } => {
Type::ResolvedPath { ref path, ref did } => {
let mut new_path = path.clone();
let last_segment =
new_path.segments.pop().expect("segments were empty");
@@ -389,11 +389,7 @@ impl<'a, 'tcx> AutoTraitFinder<'a, 'tcx> {
.segments
.push(PathSegment { name: last_segment.name, args: new_params });

Type::ResolvedPath {
path: new_path,
did: *did,
is_generic: *is_generic,
}
Type::ResolvedPath { path: new_path, did: *did }
}
_ => panic!("Unexpected data: {:?}, {:?}", ty, data),
};
@@ -563,11 +559,7 @@ impl<'a, 'tcx> AutoTraitFinder<'a, 'tcx> {
Type::QPath { name: left_name, ref self_type, ref trait_, .. } => {
let ty = &*self_type;
match **trait_ {
Type::ResolvedPath {
path: ref trait_path,
ref did,
ref is_generic,
} => {
Type::ResolvedPath { path: ref trait_path, ref did } => {
let mut new_trait_path = trait_path.clone();

if self.is_fn_ty(trait_) && left_name == sym::Output {
@@ -612,7 +604,6 @@ impl<'a, 'tcx> AutoTraitFinder<'a, 'tcx> {
trait_: Type::ResolvedPath {
path: new_trait_path,
did: *did,
is_generic: *is_generic,
},
generic_params: Vec::new(),
},
13 changes: 5 additions & 8 deletions src/librustdoc/clean/mod.rs
Original file line number Diff line number Diff line change
@@ -168,7 +168,7 @@ impl Clean<Type> for (ty::TraitRef<'_>, &[TypeBinding]) {

debug!("ty::TraitRef\n subst: {:?}\n", trait_ref.substs);

ResolvedPath { path, did: trait_ref.def_id, is_generic: false }
ResolvedPath { path, did: trait_ref.def_id }
}
}

@@ -1440,12 +1440,12 @@ impl<'tcx> Clean<Type> for Ty<'tcx> {
};
inline::record_extern_fqn(cx, did, kind);
let path = external_path(cx, did, false, vec![], substs);
ResolvedPath { path, did, is_generic: false }
ResolvedPath { path, did }
}
ty::Foreign(did) => {
inline::record_extern_fqn(cx, did, ItemType::ForeignType);
let path = external_path(cx, did, false, vec![], InternalSubsts::empty());
ResolvedPath { path, did, is_generic: false }
ResolvedPath { path, did }
}
ty::Dynamic(ref obj, ref reg) => {
// HACK: pick the first `did` as the `did` of the trait object. Someone
@@ -1471,7 +1471,7 @@ impl<'tcx> Clean<Type> for Ty<'tcx> {
let path = external_path(cx, did, false, vec![], empty);
inline::record_extern_fqn(cx, did, ItemType::Trait);
let bound = PolyTrait {
trait_: ResolvedPath { path, did, is_generic: false },
trait_: ResolvedPath { path, did },
generic_params: Vec::new(),
};
bounds.push(bound);
@@ -1488,10 +1488,7 @@ impl<'tcx> Clean<Type> for Ty<'tcx> {
let path = external_path(cx, did, false, bindings, substs);
bounds.insert(
0,
PolyTrait {
trait_: ResolvedPath { path, did, is_generic: false },
generic_params: Vec::new(),
},
PolyTrait { trait_: ResolvedPath { path, did }, generic_params: Vec::new() },
);

DynTrait(bounds, lifetime)
24 changes: 15 additions & 9 deletions src/librustdoc/clean/types.rs
Original file line number Diff line number Diff line change
@@ -1114,10 +1114,7 @@ impl GenericBound {
let path = external_path(cx, did, false, vec![], empty);
inline::record_extern_fqn(cx, did, ItemType::Trait);
GenericBound::TraitBound(
PolyTrait {
trait_: ResolvedPath { path, did, is_generic: false },
generic_params: Vec::new(),
},
PolyTrait { trait_: ResolvedPath { path, did }, generic_params: Vec::new() },
hir::TraitBoundModifier::Maybe,
)
}
@@ -1384,8 +1381,6 @@ crate enum Type {
ResolvedPath {
path: Path,
did: DefId,
/// `true` if is a `T::Name` path for associated types.
is_generic: bool,
},
/// `dyn for<'a> Trait<'a> + Send + 'static`
DynTrait(Vec<PolyTrait>, Option<Lifetime>),
@@ -1503,9 +1498,10 @@ impl Type {
}
}

crate fn is_generic(&self) -> bool {
match *self {
ResolvedPath { is_generic, .. } => is_generic,
/// Checks if this is a `T::Name` path for an associated type.
crate fn is_assoc_ty(&self) -> bool {
match self {
ResolvedPath { path, .. } => path.is_assoc_ty(),
_ => false,
}
}
@@ -1994,6 +1990,16 @@ impl Path {
String::from(if self.global { "::" } else { "" })
+ &self.segments.iter().map(|s| s.name.to_string()).collect::<Vec<_>>().join("::")
}

/// Checks if this is a `T::Name` path for an associated type.
crate fn is_assoc_ty(&self) -> bool {
match self.res {
Res::SelfTy(..) if self.segments.len() != 1 => true,
Res::Def(DefKind::TyParam, _) if self.segments.len() != 1 => true,
Res::Def(DefKind::AssocTy, _) => true,
_ => false,
}
}
}

#[derive(Clone, PartialEq, Eq, Debug, Hash)]
24 changes: 9 additions & 15 deletions src/librustdoc/clean/utils.rs
Original file line number Diff line number Diff line change
@@ -159,9 +159,7 @@ pub(super) fn external_path(

crate fn strip_type(ty: Type) -> Type {
match ty {
Type::ResolvedPath { path, did, is_generic } => {
Type::ResolvedPath { path: strip_path(&path), did, is_generic }
}
Type::ResolvedPath { path, did } => Type::ResolvedPath { path: strip_path(&path), did },
Type::DynTrait(mut bounds, lt) => {
let first = bounds.remove(0);
let stripped_trait = strip_type(first.trait_);
@@ -404,19 +402,15 @@ crate fn print_const_expr(tcx: TyCtxt<'_>, body: hir::BodyId) -> String {
crate fn resolve_type(cx: &mut DocContext<'_>, path: Path) -> Type {
debug!("resolve_type({:?})", path);

let is_generic = match path.res {
Res::PrimTy(p) => return Primitive(PrimitiveType::from(p)),
Res::SelfTy(..) if path.segments.len() == 1 => {
return Generic(kw::SelfUpper);
}
Res::Def(DefKind::TyParam, _) if path.segments.len() == 1 => {
return Generic(path.segments[0].name);
match path.res {
Res::PrimTy(p) => Primitive(PrimitiveType::from(p)),
Res::SelfTy(..) if path.segments.len() == 1 => Generic(kw::SelfUpper),
Res::Def(DefKind::TyParam, _) if path.segments.len() == 1 => Generic(path.segments[0].name),
_ => {
let did = register_res(cx, path.res);
ResolvedPath { path, did }
}
Res::SelfTy(..) | Res::Def(DefKind::TyParam | DefKind::AssocTy, _) => true,
_ => false,
};
let did = register_res(cx, path.res);
ResolvedPath { path, did, is_generic }
}
}

crate fn get_auto_trait_and_blanket_impls(
37 changes: 13 additions & 24 deletions src/librustdoc/html/format.rs
Original file line number Diff line number Diff line change
@@ -752,9 +752,9 @@ fn fmt_type<'cx>(

match *t {
clean::Generic(name) => write!(f, "{}", name),
clean::ResolvedPath { did, ref path, is_generic } => {
clean::ResolvedPath { did, ref path } => {
// Paths like `T::Output` and `Self::Output` should be rendered with all segments.
resolved_path(f, did, path, is_generic, use_absolute, cx)
resolved_path(f, did, path, path.is_assoc_ty(), use_absolute, cx)
}
clean::DynTrait(ref bounds, ref lt) => {
f.write_str("dyn ")?;
@@ -825,28 +825,17 @@ fn fmt_type<'cx>(
hir::Mutability::Mut => "mut",
hir::Mutability::Not => "const",
};
match **t {
clean::Generic(_) | clean::ResolvedPath { is_generic: true, .. } => {
if f.alternate() {
primitive_link(
f,
clean::PrimitiveType::RawPointer,
&format!("*{} {:#}", m, t.print(cx)),
cx,
)
} else {
primitive_link(
f,
clean::PrimitiveType::RawPointer,
&format!("*{} {}", m, t.print(cx)),
cx,
)
}
}
_ => {
primitive_link(f, clean::PrimitiveType::RawPointer, &format!("*{} ", m), cx)?;
fmt::Display::fmt(&t.print(cx), f)
}

if matches!(**t, clean::Generic(_)) || t.is_assoc_ty() {
let text = if f.alternate() {
format!("*{} {:#}", m, t.print(cx))
} else {
format!("*{} {}", m, t.print(cx))
};
primitive_link(f, clean::PrimitiveType::RawPointer, &text, cx)
} else {
primitive_link(f, clean::PrimitiveType::RawPointer, &format!("*{} ", m), cx)?;
fmt::Display::fmt(&t.print(cx), f)
}
}
clean::BorrowedRef { lifetime: ref l, mutability, type_: ref ty } => {
18 changes: 9 additions & 9 deletions src/librustdoc/html/render/print_item.rs
Original file line number Diff line number Diff line change
@@ -712,11 +712,10 @@ fn item_trait(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, t: &clean::Tra
let mut implementor_dups: FxHashMap<Symbol, (DefId, bool)> = FxHashMap::default();
for implementor in implementors {
match implementor.inner_impl().for_ {
clean::ResolvedPath { ref path, did, is_generic: false, .. }
clean::ResolvedPath { ref path, did, .. }
| clean::BorrowedRef {
type_: box clean::ResolvedPath { ref path, did, is_generic: false, .. },
..
} => {
type_: box clean::ResolvedPath { ref path, did, .. }, ..
} if !path.is_assoc_ty() => {
let &mut (prev_did, ref mut has_duplicates) =
implementor_dups.entry(path.last()).or_insert((did, false));
if prev_did != did {
@@ -1410,11 +1409,12 @@ fn render_implementor(
// If there's already another implementor that has the same abridged name, use the
// full path, for example in `std::iter::ExactSizeIterator`
let use_absolute = match implementor.inner_impl().for_ {
clean::ResolvedPath { ref path, is_generic: false, .. }
| clean::BorrowedRef {
type_: box clean::ResolvedPath { ref path, is_generic: false, .. },
..
} => implementor_dups[&path.last()].1,
clean::ResolvedPath { ref path, .. }
| clean::BorrowedRef { type_: box clean::ResolvedPath { ref path, .. }, .. }
if !path.is_assoc_ty() =>
{
implementor_dups[&path.last()].1
}
_ => false,
};
render_impl(
2 changes: 1 addition & 1 deletion src/librustdoc/json/conversions.rs
Original file line number Diff line number Diff line change
@@ -387,7 +387,7 @@ impl FromWithTcx<clean::Type> for Type {
fn from_tcx(ty: clean::Type, tcx: TyCtxt<'_>) -> Self {
use clean::Type::*;
match ty {
ResolvedPath { path, did, is_generic: _ } => Type::ResolvedPath {
ResolvedPath { path, did } => Type::ResolvedPath {
name: path.whole_name(),
id: from_item_id(did.into()),
args: path.segments.last().map(|args| Box::new(args.clone().args.into_tcx(tcx))),
2 changes: 1 addition & 1 deletion src/librustdoc/passes/stripper.rs
Original file line number Diff line number Diff line change
@@ -128,7 +128,7 @@ impl<'a> DocFolder for ImplStripper<'a> {
return None;
}
if let Some(did) = imp.for_.def_id() {
if did.is_local() && !imp.for_.is_generic() && !self.retained.contains(&did.into())
if did.is_local() && !imp.for_.is_assoc_ty() && !self.retained.contains(&did.into())
{
debug!("ImplStripper: impl item for stripped type; removing");
return None;