Skip to content

rustdoc-search: add unbox flag to Result aliases #139688

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

Merged
merged 1 commit into from
Apr 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions compiler/rustc_passes/src/check_attr.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1109,6 +1109,7 @@ impl<'tcx> CheckAttrVisitor<'tcx> {
ItemKind::Trait(_, _, _, generics, _, items)
if generics.params.len() != 0
|| items.iter().any(|item| matches!(item.kind, AssocItemKind::Type)) => {}
ItemKind::TyAlias(_, _, generics) if generics.params.len() != 0 => {}
_ => {
self.dcx().emit_err(errors::DocSearchUnboxInvalid { span: meta.span() });
}
Expand Down
1 change: 1 addition & 0 deletions library/std/src/io/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ use crate::{error, fmt, result, sys};
/// }
/// ```
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(not(bootstrap), doc(search_unbox))]
pub type Result<T> = result::Result<T, Error>;

/// The error type for I/O operations of the [`Read`], [`Write`], [`Seek`], and
Expand Down
1 change: 1 addition & 0 deletions library/std/src/thread/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1676,6 +1676,7 @@ impl fmt::Debug for Thread {
/// [`Result`]: crate::result::Result
/// [`std::panic::resume_unwind`]: crate::panic::resume_unwind
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(not(bootstrap), doc(search_unbox))]
pub type Result<T> = crate::result::Result<T, Box<dyn Any + Send + 'static>>;

// This packet is used to communicate the return value between the spawned
Expand Down
20 changes: 20 additions & 0 deletions tests/rustdoc-js-std/unbox-type-result.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// exact-check

// Test case for https://github.com/rust-lang/rust/issues/139665
// make sure that std::io::Result and std::thread::Result get unboxed

const EXPECTED = [
{
query: "File -> Metadata",
others: [
{ path: "std::fs::File", name: "metadata" },
{ path: "std::fs::File", name: "metadata_at" },
]
},
{
query: "JoinHandle<T> -> T",
others: [
{ path: "std::thread::JoinHandle", name: "join" },
]
},
];
6 changes: 6 additions & 0 deletions tests/rustdoc-js/generics-unbox.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,10 @@ const EXPECTED = [
{ 'path': 'generics_unbox', 'name': 'beta' },
],
},
{
'query': '-> Sigma',
'others': [
{ 'path': 'generics_unbox', 'name': 'delta' },
],
},
];
12 changes: 12 additions & 0 deletions tests/rustdoc-js/generics-unbox.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,15 @@ pub fn beta<T, U>(_: Inside<T>) -> Out<Out3<T, U>, Out4<U, T>> {
pub fn gamma<T, U>(_: Inside<T>) -> Out<Out3<U, T>, Out4<T, U>> {
loop {}
}

pub fn delta(_: i32) -> Epsilon<Sigma> {
loop {}
}

#[doc(search_unbox)]
pub struct Theta<T>(T);

#[doc(search_unbox)]
pub type Epsilon<T> = Theta<T>;

pub struct Sigma;
Loading