[rustdoc-json] Show whether `?Sized` parameters are actually `Sized` #143559

obi1kenobi · 2025-07-07T04:22:29Z

An attempt at fixing #143197 for rustdoc JSON only, in order to streamline the review process. Any HTML changes will happen separately.

Add a new allow_unsized: bool field to GenericParamDefKind::Type.
Expose that field as-is to rustdoc JSON, without tampering with ?Sized clauses there.

r? fmease

rustbot · 2025-07-07T04:22:33Z

fmease is currently at their maximum review capacity.
They may take a while to respond.

obi1kenobi · 2025-07-07T04:22:40Z

cc @aDotInTheVoid

fmease · 2025-07-07T04:54:37Z

I know this is WIP but if I may let me collect initial perf data (I've only skimmed the changes and haven't reviewed anything yet).

[@]bors2 try [@]rust-timer queue

rust-bors · 2025-07-07T04:54:41Z

⌛ Trying commit bba78b8 with merge 55a9833…

To cancel the try build, run the command @bors2 try cancel.

Show whether `?Sized` parameters are actually `Sized` A mostly-working, "some polish still required" attempt at fixing #143197 - Add a new `allow_unsized: bool` field to `GenericParamDefKind::Type`. - Expose that field as-is to rustdoc JSON, without tampering with `?Sized` clauses there. - Suppress `?Sized` from HTML where `Sized` is implied. I haven't figured out a good way to suppress `?Sized` from `impl Trait` in function parameters in HTML yet. The synthetic generics data doesn't seem to be "nearby" so more refactoring might be needed. I included a failing test case to remind me of this. r? fmease

rust-bors · 2025-07-07T07:11:14Z

☀️ Try build successful (CI)
Build commit: 55a9833 (55a98339ad460f9063d820eb23c41710d6f6e5b9, parent: ca98d4d4b3114116203699c2734805547df86f9a)

rust-timer · 2025-07-07T12:54:49Z

Finished benchmarking commit (55a9833): comparison URL.

Overall result: ❌ regressions - please read the text below

Benchmarking this pull request means it may be perf-sensitive – we'll automatically label it not fit for rolling up. You can override this, but we strongly advise not to, due to possible changes in compiler perf.

Next Steps: If you can justify the regressions found in this try perf run, please do so in sufficient writing along with @rustbot label: +perf-regression-triaged. If not, please fix the regressions and do another perf run. If its results are neutral or positive, the label will be automatically removed.

@bors rollup=never
@rustbot label: -S-waiting-on-perf +perf-regression

Instruction count

Our most reliable metric. Used to determine the overall result above. However, even this metric can be noisy.

	mean	range	count
Regressions ❌ (primary)	1.2%	[0.2%, 3.1%]	20
Regressions ❌ (secondary)	2.0%	[0.4%, 3.9%]	25
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	1.2%	[0.2%, 3.1%]	20

Max RSS (memory usage)

Results (primary 1.6%, secondary 2.4%)

A less reliable metric. May be of interest, but not used to determine the overall result above.

	mean	range	count
Regressions ❌ (primary)	1.6%	[1.2%, 2.0%]	6
Regressions ❌ (secondary)	2.4%	[1.4%, 3.9%]	3
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	1.6%	[1.2%, 2.0%]	6

Cycles

Results (primary 2.4%, secondary 2.7%)

A less reliable metric. May be of interest, but not used to determine the overall result above.

	mean	range	count
Regressions ❌ (primary)	2.4%	[2.0%, 2.9%]	6
Regressions ❌ (secondary)	3.1%	[2.4%, 3.7%]	15
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-2.8%	[-2.8%, -2.8%]	1
All ❌✅ (primary)	2.4%	[2.0%, 2.9%]	6

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 463.852s -> 465.016s (0.25%)
Artifact size: 372.07 MiB -> 372.15 MiB (0.02%)

aDotInTheVoid

(I've not looked at the impl).

I agree that we should probably remove these misleading bounds in HTML.

But I wounder if we should do the same in JSON? Rather than having a separate bool field?

aDotInTheVoid · 2025-07-07T22:49:58Z

tests/rustdoc-json/allow_unsized.rs

+
+// Generic functions
+//@ is "$.index[?(@.name=='func_custom')].inner.function.generics.params[0].kind.type.allow_unsized" false
+pub fn func_custom<T: ?Sized + CustomSized>() {}


This should test that we don't remove the ?Sized bound from the bounds list, even though it ends up not mattering.

obi1kenobi · 2025-07-08T00:30:18Z

But I wonder if we should do the same in JSON? Rather than having a separate bool field?

It's a good question. I think there are two broadly-speaking reasonable choices, and one option we should avoid.

We should avoid stripping ?Sized without including a way to say we did so. If we did that, cargo-semver-checks will get flooded with incorrect "false-positive" bug reports of people saying "look ?Sized is right here but c-s-c says I removed it." We'll probably end up having to try to parse source code to figure out if ?Sized is there so we can customize the diagnostic message to explain why the ?Sized bound doesn't matter. This isn't great and I'd love to avoid it if we can. I bet cargo-public-api would have the same issue, so I don't think it's unique to us.

Then the two broadly-acceptable options are both adding a bool, and differ over what the bool says:

leave ?Sized in but say if unsized types are disallowed despite it (this PR)
strip ?Sized but say if it was originally present

I'm ambivalent between the two options, and could easily be talked into going for the second one if you have a strong preference that way.

obi1kenobi · 2025-07-08T00:45:41Z

Taking a look at the benchmarks, I'm surprised that e.g. a simple "hello world" program takes 3% more instructions to document when there are no generics in it. This seems suspect — I wouldn't expect my code changes to get hit basically at all, let alone to the tune of a 3% slowdown.

aDotInTheVoid · 2025-08-11T16:43:23Z

Then the two broadly-acceptable options are both adding a bool, and differ over what the bool says:

leave ?Sized in but say if unsized types are disallowed despite it (this PR)

strip ?Sized but say if it was originally present

I'm strongly in favour if the first option. That way, consumers arn't required to look at that field if they don't need to.

I agree that we should probably remove these misleading bounds in HTML.

EDIT: Stuff in here was incorrect, see fmeases comment below

~~I'm less sure about this now. If I have~~

pub fn foo<T: othercrate::Trait + ?Sized>(_t: T)

~~And othercrate goes from:~~

pub trait Trait {}

to

pub trait Trait: ?Sized {}

~~than that changes the meaning of my code, and the ?Sized bound on foo now matters.~~

At the very least, the HTML change will want to go through a T-rustdoc-frontend fcp/poll. It's worth spinning of to a seperate PR, to unblock the JSON change.

fmease · 2025-08-11T16:47:46Z

pub trait Trait: ?Sized {} isn't allowed, traits are ?Sized by default and for a trait to go from trait Trait {} to trait Trait: Sized {} would be a breaking change on its own.

…implied.

obi1kenobi · 2025-08-20T03:41:01Z

Updated to only include rustdoc JSON changes as suggested.

If required, I plan to open a PR with the HTML changes separately after we have a final outcome on this PR. I've saved the old contents of the branch (including HTML changes and tests) under a different branch name.

I believe this PR should now pass the rustdoc JSON test suite, and leave the HTML tests unchanged.

I'm not sure what to do about the perf change, though it's possible removing the HTML changes has had some impact. It may be prudent to re-measure before we decide.

@rustbot label -T-rustdoc-frontend

rustbot · 2025-08-20T03:41:14Z

rustdoc-json-types is a public (although nightly-only) API. If possible, consider changing src/librustdoc/json/conversions.rs; otherwise, make sure you bump the FORMAT_VERSION constant.

cc @CraftSpider, @aDotInTheVoid, @Enselic, @obi1kenobi

These commits modify tests/rustdoc-json.
rustdoc-json is a public (but unstable) interface.

Please ensure that if you've changed the output:

It's intentional.
The FORMAT_VERSION in src/librustdoc-json-types is bumped if necessary.

cc @aDotInTheVoid, @obi1kenobi

aDotInTheVoid · 2025-08-20T17:02:12Z

@bors2 try @rust-timer queue

I’m happy this is the correct approach/behaviour/public api, but haven’t reviewed the implementation (yet). I’ll either do that in a week when I’m back from camping, or you could ask fmease (or someone else on T-Rustdoc) to do it beforehand.

[rustdoc-json] Show whether `?Sized` parameters are actually `Sized`

rust-bors · 2025-08-20T19:17:45Z

☀️ Try build successful (CI)
Build commit: c1707dd (c1707dd4e3487b87d643b25dd6de03155310caab, parent: e8a792daf500b5ff8097896ddb6cc037abe92487)

rust-timer · 2025-08-20T20:28:03Z

Finished benchmarking commit (c1707dd): comparison URL.

Overall result: ❌ regressions - please read the text below

Benchmarking this pull request means it may be perf-sensitive – we'll automatically label it not fit for rolling up. You can override this, but we strongly advise not to, due to possible changes in compiler perf.

Next Steps: If you can justify the regressions found in this try perf run, please do so in sufficient writing along with @rustbot label: +perf-regression-triaged. If not, please fix the regressions and do another perf run. If its results are neutral or positive, the label will be automatically removed.

@bors rollup=never
@rustbot label: -S-waiting-on-perf +perf-regression

Instruction count

Our most reliable metric. Used to determine the overall result above. However, even this metric can be noisy.

	mean	range	count
Regressions ❌ (primary)	0.9%	[0.3%, 2.0%]	16
Regressions ❌ (secondary)	1.3%	[0.3%, 2.8%]	26
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	0.9%	[0.3%, 2.0%]	16

Max RSS (memory usage)

Results (primary 1.8%)

A less reliable metric. May be of interest, but not used to determine the overall result above.

	mean	range	count
Regressions ❌ (primary)	1.8%	[1.6%, 2.1%]	4
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	1.8%	[1.6%, 2.1%]	4

Cycles

Results (primary 2.8%, secondary 2.0%)

A less reliable metric. May be of interest, but not used to determine the overall result above.

	mean	range	count
Regressions ❌ (primary)	2.8%	[2.1%, 3.6%]	3
Regressions ❌ (secondary)	2.8%	[2.2%, 3.7%]	13
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-3.6%	[-4.0%, -3.2%]	2
All ❌✅ (primary)	2.8%	[2.1%, 3.6%]	3

Binary size

Results (secondary 0.0%)

A less reliable metric. May be of interest, but not used to determine the overall result above.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	0.0%	[0.0%, 0.0%]	1
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	-	-	0

Bootstrap: 471.66s -> 469.982s (-0.36%)
Artifact size: 378.20 MiB -> 378.25 MiB (0.01%)

bors · 2025-08-28T23:57:13Z

☔ The latest upstream changes (presumably #145970) made this pull request unmergeable. Please resolve the merge conflicts.

rustbot assigned fmease Jul 7, 2025

rustbot added A-rustdoc-json Area: Rustdoc JSON backend T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Jul 7, 2025

This comment has been minimized.

Sign in to view

rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Jul 7, 2025

This comment has been minimized.

Sign in to view

rustbot added perf-regression Performance regression. and removed S-waiting-on-perf Status: Waiting on a perf run to be completed. labels Jul 7, 2025

aDotInTheVoid reviewed Jul 7, 2025

View reviewed changes

[rustdoc-json] Suppress ?Sized bounds from rustdoc when Sized is …

85e32ef

…implied.

obi1kenobi changed the title ~~Show whether ?Sized parameters are actually Sized~~ [rustdoc-json] Show whether ?Sized parameters are actually Sized Aug 20, 2025

obi1kenobi force-pushed the pg/allow_unsized branch from bba78b8 to 85e32ef Compare August 20, 2025 03:40

rustbot removed the T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. label Aug 20, 2025

obi1kenobi marked this pull request as ready for review August 20, 2025 03:41

rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 20, 2025

obi1kenobi requested a review from aDotInTheVoid August 20, 2025 03:43

This comment has been minimized.

Sign in to view

rust-bors bot added a commit that referenced this pull request Aug 20, 2025

Auto merge of #143559 - obi1kenobi:pg/allow_unsized, r=<try>

c1707dd

[rustdoc-json] Show whether `?Sized` parameters are actually `Sized`

This comment has been minimized.

Sign in to view

rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Aug 20, 2025

This comment has been minimized.

Sign in to view

rustbot removed the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Aug 20, 2025

[rustdoc-json] Show whether ?Sized parameters are actually Sized #143559

Are you sure you want to change the base?

[rustdoc-json] Show whether ?Sized parameters are actually Sized #143559

Uh oh!

Conversation

obi1kenobi commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Jul 7, 2025

Uh oh!

obi1kenobi commented Jul 7, 2025

Uh oh!

This comment has been minimized.

fmease commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

rust-bors bot commented Jul 7, 2025

Uh oh!

rust-bors bot commented Jul 7, 2025

Uh oh!

This comment has been minimized.

rust-timer commented Jul 7, 2025

Overall result: ❌ regressions - please read the text below

Uh oh!

aDotInTheVoid left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

obi1kenobi commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

obi1kenobi commented Jul 8, 2025

Uh oh!

aDotInTheVoid commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fmease commented Aug 11, 2025

Uh oh!

obi1kenobi commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Aug 20, 2025

Uh oh!

aDotInTheVoid commented Aug 20, 2025

Uh oh!

This comment has been minimized.

This comment has been minimized.

rust-bors bot commented Aug 20, 2025

Uh oh!

This comment has been minimized.

rust-timer commented Aug 20, 2025

Overall result: ❌ regressions - please read the text below

Uh oh!

bors commented Aug 28, 2025

Uh oh!

Uh oh!

[rustdoc-json] Show whether `?Sized` parameters are actually `Sized` #143559

[rustdoc-json] Show whether `?Sized` parameters are actually `Sized` #143559

obi1kenobi commented Jul 7, 2025 •

edited

Loading

fmease commented Jul 7, 2025 •

edited

Loading

obi1kenobi commented Jul 8, 2025 •

edited

Loading

aDotInTheVoid commented Aug 11, 2025 •

edited

Loading

obi1kenobi commented Aug 20, 2025 •

edited

Loading