Skip to content

Commit 40ba791

Browse files
committed
rustdoc_json: Fix handling of paths with no generic args.
A path without generic args, like `Reader`, currently has JSON produced like this: ``` {"path":"Reader","id":286,"args":{"angle_bracketed":{"args":[],"constraints":[]}}} ``` Even though `types::Path::args` is `Option` and allows for "no args", instead it gets represented as "empty args". (More like `Reader<>` than `Reader`.) This is due to a problem in `clean::Path::from_clean`. It only produces `None` if the path is an empty string. This commit changes it to also produce `None` if there are no generic args. The example above becomes: ``` {"path":"Reader","id":286,"args":null} ``` I looked at a few examples and saw this reduce the size of the JSON output by 3-9%. The commit also adds an assertion that non-final segments don't have any generics; something the old code was implicitly relying on. Note: the original sin here is that `clean::PathSegment::args` is not an `Option`, unlike `{ast,hir}::PathSegment::args`. I want to fix that, but it can be done separately.
1 parent 18d742b commit 40ba791

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

src/librustdoc/json/conversions.rs

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,24 @@ impl FromClean<clean::Path> for Path {
579579
Path {
580580
path: path.whole_name(),
581581
id: renderer.id_from_item_default(path.def_id().into()),
582-
args: path.segments.last().map(|args| Box::new(args.args.into_json(renderer))),
582+
args: {
583+
if let Some((final_seg, rest_segs)) = path.segments.split_last() {
584+
// In general, `clean::Path` can hold things like
585+
// `std::vec::Vec::<u32>::new`, where generic args appear
586+
// in a middle segment. But for the places where `Path` is
587+
// used by rustdoc-json-types, generic args can only be
588+
// used in the final segment, e.g. `std::vec::Vec<u32>`. So
589+
// check that the non-final segments have no generic args.
590+
assert!(rest_segs.iter().all(|seg| seg.args.is_empty()));
591+
if final_seg.args.is_empty() {
592+
None
593+
} else {
594+
Some(Box::new(final_seg.args.into_json(renderer)))
595+
}
596+
} else {
597+
None // no generics on any segments because there are no segments
598+
}
599+
},
583600
}
584601
}
585602
}

tests/rustdoc-json/generic-args.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ impl MyTrait for MyStruct {
1111
}
1212

1313
//@ is "$.index[?(@.name=='my_fn1')].inner.function.sig.inputs[0][1].qualified_path.args" {\"angle_bracketed\":{\"args\":[],\"constraints\":[]}}
14-
//@ is "$.index[?(@.name=='my_fn1')].inner.function.sig.inputs[0][1].qualified_path.self_type.resolved_path.args" {\"angle_bracketed\":{\"args\":[],\"constraints\":[]}}
14+
//@ is "$.index[?(@.name=='my_fn1')].inner.function.sig.inputs[0][1].qualified_path.self_type.resolved_path.args" null
1515
pub fn my_fn1(_: <MyStruct as MyTrait>::MyType) {}
1616

1717
//@ is "$.index[?(@.name=='my_fn2')].inner.function.sig.inputs[0][1].dyn_trait.traits[0].trait.args.angle_bracketed.constraints[0].args" {\"angle_bracketed\":{\"args\":[],\"constraints\":[]}}

0 commit comments

Comments
 (0)