Skip to content

Commit

Permalink
rustdoc: Show "const" for const-unstable if also overall unstable
Browse files Browse the repository at this point in the history
If a const function is unstable overall (and thus, in all circumstances
I know of, also const-unstable), we should show the option to use it as
const. You need to enable a feature to use the function at all anyway.

If the function is stabilized without also being const-stabilized, then
we do not show the const keyword and instead show "const: unstable" in
the version info.
  • Loading branch information
camelid committed May 27, 2024
1 parent fa7a3f9 commit 699d28f
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 20 deletions.
7 changes: 3 additions & 4 deletions src/librustdoc/clean/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -627,7 +627,7 @@ impl Item {
) -> hir::FnHeader {
let sig = tcx.fn_sig(def_id).skip_binder();
let constness =
if tcx.is_const_fn(def_id) && is_unstable_const_fn(tcx, def_id).is_none() {
if tcx.is_const_fn(def_id) || is_unstable_const_fn(tcx, def_id).is_some() {
hir::Constness::Const
} else {
hir::Constness::NotConst
Expand All @@ -649,9 +649,8 @@ impl Item {
hir::Safety::Unsafe
},
abi,
constness: if abi == Abi::RustIntrinsic
&& tcx.is_const_fn(def_id)
&& is_unstable_const_fn(tcx, def_id).is_none()
constness: if tcx.is_const_fn(def_id)
|| is_unstable_const_fn(tcx, def_id).is_some()
{
hir::Constness::Const
} else {
Expand Down
29 changes: 18 additions & 11 deletions src/librustdoc/html/format.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use std::fmt::{self, Display, Write};
use std::iter::{self, once};

use rustc_ast as ast;
use rustc_attr::{ConstStability, StabilityLevel};
use rustc_attr::{ConstStability, StabilityLevel, StableSince};
use rustc_data_structures::captures::Captures;
use rustc_data_structures::fx::FxHashSet;
use rustc_hir as hir;
Expand Down Expand Up @@ -1633,17 +1633,24 @@ impl PrintWithSpace for hir::Mutability {

pub(crate) fn print_constness_with_space(
c: &hir::Constness,
s: Option<ConstStability>,
overall_stab: Option<StableSince>,
const_stab: Option<ConstStability>,
) -> &'static str {
match (c, s) {
// const stable or when feature(staged_api) is not set
(
hir::Constness::Const,
Some(ConstStability { level: StabilityLevel::Stable { .. }, .. }),
)
| (hir::Constness::Const, None) => "const ",
// const unstable or not const
_ => "",
match c {
hir::Constness::Const => match (overall_stab, const_stab) {
// const stable...
(_, Some(ConstStability { level: StabilityLevel::Stable { .. }, .. }))
// ...or when feature(staged_api) is not set...
| (_, None)
// ...or when const unstable, but overall unstable too
| (None, Some(ConstStability { level: StabilityLevel::Unstable { .. }, .. })) => {
"const "
}
// const unstable (and overall stable)
(Some(_), Some(ConstStability { level: StabilityLevel::Unstable { .. }, .. })) => "",
},
// not const
hir::Constness::NotConst => "",
}
}

Expand Down
8 changes: 5 additions & 3 deletions src/librustdoc/html/render/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -928,9 +928,11 @@ fn assoc_method(
// FIXME: Once https://github.com/rust-lang/rust/issues/67792 is implemented, we can remove
// this condition.
let constness = match render_mode {
RenderMode::Normal => {
print_constness_with_space(&header.constness, meth.const_stability(tcx))
}
RenderMode::Normal => print_constness_with_space(
&header.constness,
meth.stable_since(tcx),
meth.const_stability(tcx),
),
RenderMode::ForDeref { .. } => "",
};
let asyncness = header.asyncness.print_with_space();
Expand Down
13 changes: 12 additions & 1 deletion src/librustdoc/html/render/print_item.rs
Original file line number Diff line number Diff line change
Expand Up @@ -615,7 +615,18 @@ fn extra_info_tags<'a, 'tcx: 'a>(
fn item_function(w: &mut Buffer, cx: &mut Context<'_>, it: &clean::Item, f: &clean::Function) {
let tcx = cx.tcx();
let header = it.fn_header(tcx).expect("printing a function which isn't a function");
let constness = print_constness_with_space(&header.constness, it.const_stability(tcx));
debug!(
"item_function/const: {:?} {:?} {:?} {:?}",
it.name,
&header.constness,
it.stable_since(tcx),
it.const_stability(tcx),
);
let constness = print_constness_with_space(
&header.constness,
it.stable_since(tcx),
it.const_stability(tcx),
);
let safety = header.safety.print_with_space();
let abi = print_abi_with_space(header.abi).to_string();
let asyncness = header.asyncness.print_with_space();
Expand Down
2 changes: 1 addition & 1 deletion tests/rustdoc/const-display.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ pub const unsafe fn foo_unsafe() -> u32 { 42 }
#[unstable(feature = "humans", issue = "none")]
pub const fn foo2() -> u32 { 42 }

// @has 'foo/fn.foo3.html' '//pre' 'pub fn foo3() -> u32'
// @has 'foo/fn.foo3.html' '//pre' 'pub const fn foo3() -> u32'
// @!hasraw - '//span[@class="since"]'
#[unstable(feature = "humans", issue = "none")]
#[rustc_const_unstable(feature = "humans", issue = "none")]
Expand Down

0 comments on commit 699d28f

Please sign in to comment.