From b7121355756cc97bf1273a01d0206585d951699b Mon Sep 17 00:00:00 2001 From: Martin Nordholts Date: Mon, 2 May 2022 20:23:56 +0200 Subject: [PATCH 1/3] rustdoc-json-types: Improve docs for HRTB fields --- src/rustdoc-json-types/lib.rs | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/src/rustdoc-json-types/lib.rs b/src/rustdoc-json-types/lib.rs index 17b3859a77b64..c045db9b231f6 100644 --- a/src/rustdoc-json-types/lib.rs +++ b/src/rustdoc-json-types/lib.rs @@ -408,7 +408,13 @@ pub enum GenericBound { TraitBound { #[serde(rename = "trait")] trait_: Type, - /// Used for HRTBs + /// Used for Higher-Rank Trait Bounds (HRTBs) + /// ```plain + /// where F: for<'a, 'b> Fn(&'a u8, &'b u8) + /// ^^^^^^^^^^^ + /// | + /// this part + /// ``` generic_params: Vec, modifier: TraitBoundModifier, }, @@ -487,6 +493,13 @@ pub enum Type { #[derive(Clone, Debug, Serialize, Deserialize, PartialEq)] pub struct FunctionPointer { pub decl: FnDecl, + /// Used for Higher-Rank Trait Bounds (HRTBs) + /// ```plain + /// for<'c> fn(val: &'c i32) -> i32 + /// ^^^^^^^ + /// | + /// this part + /// ``` pub generic_params: Vec, pub header: Header, } From 1f15ce5f9748d523f3c1835da12b05b15648aa68 Mon Sep 17 00:00:00 2001 From: Martin Nordholts Date: Mon, 2 May 2022 20:34:12 +0200 Subject: [PATCH 2/3] rustdoc-json: Fix HRTBs for WherePredicate::BoundPredicate --- src/librustdoc/json/conversions.rs | 10 ++++++++-- src/rustdoc-json-types/lib.rs | 10 +++++++++- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/src/librustdoc/json/conversions.rs b/src/librustdoc/json/conversions.rs index 56b02cd848041..412387313dc17 100644 --- a/src/librustdoc/json/conversions.rs +++ b/src/librustdoc/json/conversions.rs @@ -350,10 +350,16 @@ impl FromWithTcx for WherePredicate { fn from_tcx(predicate: clean::WherePredicate, tcx: TyCtxt<'_>) -> Self { use clean::WherePredicate::*; match predicate { - BoundPredicate { ty, bounds, .. } => WherePredicate::BoundPredicate { + BoundPredicate { ty, bounds, bound_params } => WherePredicate::BoundPredicate { type_: ty.into_tcx(tcx), bounds: bounds.into_iter().map(|x| x.into_tcx(tcx)).collect(), - // FIXME: add `bound_params` to rustdoc-json-params? + generic_params: bound_params + .into_iter() + .map(|x| GenericParamDef { + name: x.0.to_string(), + kind: GenericParamDefKind::Lifetime { outlives: vec![] }, + }) + .collect(), }, RegionPredicate { lifetime, bounds } => WherePredicate::RegionPredicate { lifetime: lifetime.0.to_string(), diff --git a/src/rustdoc-json-types/lib.rs b/src/rustdoc-json-types/lib.rs index c045db9b231f6..eb2c8e5bae1c4 100644 --- a/src/rustdoc-json-types/lib.rs +++ b/src/rustdoc-json-types/lib.rs @@ -9,7 +9,7 @@ use std::path::PathBuf; use serde::{Deserialize, Serialize}; /// rustdoc format-version. -pub const FORMAT_VERSION: u32 = 14; +pub const FORMAT_VERSION: u32 = 15; /// A `Crate` is the root of the emitted JSON blob. It contains all type/documentation information /// about the language items in the local crate, as well as info about external items to allow @@ -391,6 +391,14 @@ pub enum WherePredicate { #[serde(rename = "type")] type_: Type, bounds: Vec, + /// Used for Higher-Rank Trait Bounds (HRTBs) + /// ```plain + /// where for<'a> &'a T: Iterator," + /// ^^^^^^^ + /// | + /// this part + /// ``` + generic_params: Vec, }, RegionPredicate { lifetime: String, From 774b525f6f5c7a8712349e67f53cfd75056fe079 Mon Sep 17 00:00:00 2001 From: Martin Nordholts Date: Wed, 4 May 2022 20:49:05 +0200 Subject: [PATCH 3/3] rustdoc-json: Add tests for all three HRTB fields --- src/test/rustdoc-json/fn_pointer/generics.rs | 14 +++++++++ src/test/rustdoc-json/fns/generic_args.rs | 32 +++++++++++++++++--- 2 files changed, 42 insertions(+), 4 deletions(-) create mode 100644 src/test/rustdoc-json/fn_pointer/generics.rs diff --git a/src/test/rustdoc-json/fn_pointer/generics.rs b/src/test/rustdoc-json/fn_pointer/generics.rs new file mode 100644 index 0000000000000..646f720e66396 --- /dev/null +++ b/src/test/rustdoc-json/fn_pointer/generics.rs @@ -0,0 +1,14 @@ +// ignore-tidy-linelength + +#![feature(no_core)] +#![no_core] + +// @count generics.json "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.decl.inputs[*]" 1 +// @is - "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.decl.inputs[0][0]" '"val"' +// @is - "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.decl.inputs[0][1].kind" '"borrowed_ref"' +// @is - "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.decl.inputs[0][1].inner.lifetime" \"\'c\" +// @is - "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.decl.output" '{ "kind": "primitive", "inner": "i32" }' +// @count - "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.generic_params[*]" 1 +// @is - "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.generic_params[0].name" \"\'c\" +// @is - "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.generic_params[0].kind" '{ "lifetime": { "outlives": [] } }' +pub type WithHigherRankTraitBounds = for<'c> fn(val: &'c i32) -> i32; diff --git a/src/test/rustdoc-json/fns/generic_args.rs b/src/test/rustdoc-json/fns/generic_args.rs index 3b03724b040ae..69150443c29dc 100644 --- a/src/test/rustdoc-json/fns/generic_args.rs +++ b/src/test/rustdoc-json/fns/generic_args.rs @@ -6,6 +6,9 @@ // @set foo = generic_args.json "$.index[*][?(@.name=='Foo')].id" pub trait Foo {} +// @set generic_foo = generic_args.json "$.index[*][?(@.name=='GenericFoo')].id" +pub trait GenericFoo<'a> {} + // @is - "$.index[*][?(@.name=='generics')].inner.generics.where_predicates" "[]" // @count - "$.index[*][?(@.name=='generics')].inner.generics.params[*]" 1 // @is - "$.index[*][?(@.name=='generics')].inner.generics.params[0].name" '"F"' @@ -29,19 +32,40 @@ pub fn generics(f: F) {} // @is - "$.index[*][?(@.name=='impl_trait')].inner.decl.inputs[0][1].inner[0].trait_bound.trait.inner.id" $foo pub fn impl_trait(f: impl Foo) {} -// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.params[*]" 1 +// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.params[*]" 3 // @is - "$.index[*][?(@.name=='where_clase')].inner.generics.params[0].name" '"F"' // @is - "$.index[*][?(@.name=='where_clase')].inner.generics.params[0].kind" '{"type": {"bounds": [], "default": null, "synthetic": false}}' -// @count - "$.index[*][?(@.name=='where_clase')].inner.decl.inputs[*]" 1 +// @count - "$.index[*][?(@.name=='where_clase')].inner.decl.inputs[*]" 3 // @is - "$.index[*][?(@.name=='where_clase')].inner.decl.inputs[0][0]" '"f"' // @is - "$.index[*][?(@.name=='where_clase')].inner.decl.inputs[0][1].kind" '"generic"' // @is - "$.index[*][?(@.name=='where_clase')].inner.decl.inputs[0][1].inner" '"F"' -// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[*]" 1 +// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[*]" 3 + // @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[0].bound_predicate.type" '{"inner": "F", "kind": "generic"}' // @count - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[0].bound_predicate.bounds[*]" 1 // @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[0].bound_predicate.bounds[0].trait_bound.trait.inner.id" $foo -pub fn where_clase(f: F) + +// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[1].bound_predicate.type" '{"inner": "G", "kind": "generic"}' +// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[1].bound_predicate.bounds[*]" 1 +// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[1].bound_predicate.bounds[0].trait_bound.trait.inner.id" $generic_foo +// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[1].bound_predicate.bounds[0].trait_bound.generic_params[*]" 1 +// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[1].bound_predicate.bounds[0].trait_bound.generic_params[0].name" \"\'a\" +// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[1].bound_predicate.bounds[0].trait_bound.generic_params[0].kind" '{ "lifetime": { "outlives": [] } }' +// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[1].bound_predicate.generic_params" "[]" + +// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.type.kind" '"borrowed_ref"' +// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.type.inner.lifetime" \"\'b\" +// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.type.inner.type" '{"inner": "H", "kind": "generic"}' +// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.bounds[*]" 1 +// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.bounds[0].trait_bound.trait.inner.id" $foo +// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.bounds[0].trait_bound.generic_params" "[]" +// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.generic_params[*]" 1 +// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.generic_params[0].name" \"\'b\" +// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.generic_params[0].kind" '{ "lifetime": { "outlives": [] } }' +pub fn where_clase(f: F, g: G, h: H) where F: Foo, + G: for<'a> GenericFoo<'a>, + for<'b> &'b H: Foo, { }