Skip to content
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit ce49ce2

Browse files
JohnTitorJohnTitor
authored
Rollup merge of rust-lang#96647 - Enselic:fix-hrtb-for-wherepredicate, r=CraftSpider
rustdoc-json: Fix HRTBs for WherePredicate::BoundPredicate Information about HRTBs are already present for `GenericBound:: TraitBound` and `FunctionPointer`. This PR adds HRTB info also to `WherePredicate::BoundPredicate`. Use the same field name and type as for the other ones (`generic_params: Vec<GenericParamDef>`). I have verified that this gives rustdoc JSON clients the data they need and in a format that is easy to work with (see Enselic/public-api#92). I will be happy to add tests for this change (and bump `FORMAT_VERSION` which I just realized I forgot), but it is always nice to get one round of feedback first, so that I don't put a lot of effort into tests that then have to be discarded. `@rustbot` modify labels: +T-rustdoc +A-rustdoc-json
2 parents 4c5f6e6 + 774b525 commit ce49ce2

File tree

4 files changed

+73
-8
lines changed

4 files changed

+73
-8
lines changed

‎src/librustdoc/json/conversions.rs

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -350,10 +350,16 @@ impl FromWithTcx<clean::WherePredicate> for WherePredicate {
350350
fn from_tcx(predicate: clean::WherePredicate, tcx: TyCtxt<'_>) -> Self {
351351
use clean::WherePredicate::*;
352352
match predicate {
353-
BoundPredicate { ty, bounds, .. } => WherePredicate::BoundPredicate {
353+
BoundPredicate { ty, bounds, bound_params } => WherePredicate::BoundPredicate {
354354
type_: ty.into_tcx(tcx),
355355
bounds: bounds.into_iter().map(|x| x.into_tcx(tcx)).collect(),
356-
// FIXME: add `bound_params` to rustdoc-json-params?
356+
generic_params: bound_params
357+
.into_iter()
358+
.map(|x| GenericParamDef {
359+
name: x.0.to_string(),
360+
kind: GenericParamDefKind::Lifetime { outlives: vec![] },
361+
})
362+
.collect(),
357363
},
358364
RegionPredicate { lifetime, bounds } => WherePredicate::RegionPredicate {
359365
lifetime: lifetime.0.to_string(),

‎src/rustdoc-json-types/lib.rs

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use std::path::PathBuf;
99
use serde::{Deserialize, Serialize};
1010

1111
/// rustdoc format-version.
12-
pub const FORMAT_VERSION: u32 = 14;
12+
pub const FORMAT_VERSION: u32 = 15;
1313

1414
/// A `Crate` is the root of the emitted JSON blob. It contains all type/documentation information
1515
/// about the language items in the local crate, as well as info about external items to allow
@@ -391,6 +391,14 @@ pub enum WherePredicate {
391391
#[serde(rename = "type")]
392392
type_: Type,
393393
bounds: Vec<GenericBound>,
394+
/// Used for Higher-Rank Trait Bounds (HRTBs)
395+
/// ```plain
396+
/// where for<'a> &'a T: Iterator,"
397+
/// ^^^^^^^
398+
/// |
399+
/// this part
400+
/// ```
401+
generic_params: Vec<GenericParamDef>,
394402
},
395403
RegionPredicate {
396404
lifetime: String,
@@ -408,7 +416,13 @@ pub enum GenericBound {
408416
TraitBound {
409417
#[serde(rename = "trait")]
410418
trait_: Type,
411-
/// Used for HRTBs
419+
/// Used for Higher-Rank Trait Bounds (HRTBs)
420+
/// ```plain
421+
/// where F: for<'a, 'b> Fn(&'a u8, &'b u8)
422+
/// ^^^^^^^^^^^
423+
/// |
424+
/// this part
425+
/// ```
412426
generic_params: Vec<GenericParamDef>,
413427
modifier: TraitBoundModifier,
414428
},
@@ -487,6 +501,13 @@ pub enum Type {
487501
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
488502
pub struct FunctionPointer {
489503
pub decl: FnDecl,
504+
/// Used for Higher-Rank Trait Bounds (HRTBs)
505+
/// ```plain
506+
/// for<'c> fn(val: &'c i32) -> i32
507+
/// ^^^^^^^
508+
/// |
509+
/// this part
510+
/// ```
490511
pub generic_params: Vec<GenericParamDef>,
491512
pub header: Header,
492513
}

‎src/test/rustdoc-json/fn_pointer/generics.rs

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// ignore-tidy-linelength
2+
3+
#![feature(no_core)]
4+
#![no_core]
5+
6+
// @count generics.json "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.decl.inputs[*]" 1
7+
// @is - "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.decl.inputs[0][0]" '"val"'
8+
// @is - "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.decl.inputs[0][1].kind" '"borrowed_ref"'
9+
// @is - "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.decl.inputs[0][1].inner.lifetime" \"\'c\"
10+
// @is - "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.decl.output" '{ "kind": "primitive", "inner": "i32" }'
11+
// @count - "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.generic_params[*]" 1
12+
// @is - "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.generic_params[0].name" \"\'c\"
13+
// @is - "$.index[*][?(@.name=='WithHigherRankTraitBounds')].inner.type.inner.generic_params[0].kind" '{ "lifetime": { "outlives": [] } }'
14+
pub type WithHigherRankTraitBounds = for<'c> fn(val: &'c i32) -> i32;

‎src/test/rustdoc-json/fns/generic_args.rs

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
// @set foo = generic_args.json "$.index[*][?(@.name=='Foo')].id"
77
pub trait Foo {}
88

9+
// @set generic_foo = generic_args.json "$.index[*][?(@.name=='GenericFoo')].id"
10+
pub trait GenericFoo<'a> {}
11+
912
// @is - "$.index[*][?(@.name=='generics')].inner.generics.where_predicates" "[]"
1013
// @count - "$.index[*][?(@.name=='generics')].inner.generics.params[*]" 1
1114
// @is - "$.index[*][?(@.name=='generics')].inner.generics.params[0].name" '"F"'
@@ -29,19 +32,40 @@ pub fn generics<F: Foo>(f: F) {}
2932
// @is - "$.index[*][?(@.name=='impl_trait')].inner.decl.inputs[0][1].inner[0].trait_bound.trait.inner.id" $foo
3033
pub fn impl_trait(f: impl Foo) {}
3134

32-
// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.params[*]" 1
35+
// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.params[*]" 3
3336
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.params[0].name" '"F"'
3437
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.params[0].kind" '{"type": {"bounds": [], "default": null, "synthetic": false}}'
35-
// @count - "$.index[*][?(@.name=='where_clase')].inner.decl.inputs[*]" 1
38+
// @count - "$.index[*][?(@.name=='where_clase')].inner.decl.inputs[*]" 3
3639
// @is - "$.index[*][?(@.name=='where_clase')].inner.decl.inputs[0][0]" '"f"'
3740
// @is - "$.index[*][?(@.name=='where_clase')].inner.decl.inputs[0][1].kind" '"generic"'
3841
// @is - "$.index[*][?(@.name=='where_clase')].inner.decl.inputs[0][1].inner" '"F"'
39-
// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[*]" 1
42+
// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[*]" 3
43+
4044
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[0].bound_predicate.type" '{"inner": "F", "kind": "generic"}'
4145
// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[0].bound_predicate.bounds[*]" 1
4246
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[0].bound_predicate.bounds[0].trait_bound.trait.inner.id" $foo
43-
pub fn where_clase<F>(f: F)
47+
48+
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[1].bound_predicate.type" '{"inner": "G", "kind": "generic"}'
49+
// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[1].bound_predicate.bounds[*]" 1
50+
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[1].bound_predicate.bounds[0].trait_bound.trait.inner.id" $generic_foo
51+
// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[1].bound_predicate.bounds[0].trait_bound.generic_params[*]" 1
52+
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[1].bound_predicate.bounds[0].trait_bound.generic_params[0].name" \"\'a\"
53+
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[1].bound_predicate.bounds[0].trait_bound.generic_params[0].kind" '{ "lifetime": { "outlives": [] } }'
54+
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[1].bound_predicate.generic_params" "[]"
55+
56+
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.type.kind" '"borrowed_ref"'
57+
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.type.inner.lifetime" \"\'b\"
58+
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.type.inner.type" '{"inner": "H", "kind": "generic"}'
59+
// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.bounds[*]" 1
60+
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.bounds[0].trait_bound.trait.inner.id" $foo
61+
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.bounds[0].trait_bound.generic_params" "[]"
62+
// @count - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.generic_params[*]" 1
63+
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.generic_params[0].name" \"\'b\"
64+
// @is - "$.index[*][?(@.name=='where_clase')].inner.generics.where_predicates[2].bound_predicate.generic_params[0].kind" '{ "lifetime": { "outlives": [] } }'
65+
pub fn where_clase<F, G, H>(f: F, g: G, h: H)
4466
where
4567
F: Foo,
68+
G: for<'a> GenericFoo<'a>,
69+
for<'b> &'b H: Foo,
4670
{
4771
}

0 commit comments

Comments
 (0)