Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs #136279

Zalathar · 2025-01-30T06:27:33Z

This is all based on my archaeology for https://rust-lang.zulipchat.com/#narrow/channel/182449-t-compiler.2Fhelp/topic/.60TyCtxtEnsure.60.

The main renamings are:

tcx.ensure() → tcx.ensure_ok()
tcx.ensure_with_value() → tcx.ensure_done()
Query modifier ensure_forwards_result_if_red → return_result_from_ensure_ok

Hopefully these new names are a better fit for the actual function and purpose of these query call modes.

rustbot · 2025-01-30T06:27:43Z

Some changes occurred to the CTFE / Miri interpreter

cc @rust-lang/miri, @rust-lang/wg-const-eval

Some changes occurred in compiler/rustc_codegen_cranelift

cc @bjorn3

Some changes occurred to MIR optimizations

cc @rust-lang/wg-mir-opt

Zalathar · 2025-01-30T06:30:44Z

(All of the changes outside the query system are just applying the renames.)

Zalathar · 2025-01-30T07:05:01Z

Also adjust query calls in librustdoc (diff).

rustbot · 2025-01-30T07:18:11Z

Some changes occurred in src/tools/clippy

cc @rust-lang/clippy

Zalathar · 2025-01-30T07:18:35Z

Also fix clippy (diff).

compiler/rustc_middle/src/query/plumbing.rs

oli-obk · 2025-01-30T08:58:41Z

r? @oli-obk

bors · 2025-01-31T13:32:14Z

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

oli-obk · 2025-01-31T13:48:21Z

r=me after a rebase

Zalathar · 2025-02-01T01:58:02Z

Rebased to resolve conflicts; I'll put this in the queue when PR CI is green.

Zalathar · 2025-02-01T02:52:04Z

@bors r=oli-obk

This might be rotty, but I'll worry about that if it actually starts conflicting.

bors · 2025-02-01T02:52:07Z

📌 Commit 3ae0239 has been approved by oli-obk

It is now in the queue for this repository.

Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs This is all based on my archaeology for https://rust-lang.zulipchat.com/#narrow/channel/182449-t-compiler.2Fhelp/topic/.60TyCtxtEnsure.60. The main renamings are: - `tcx.ensure()` → `tcx.ensure_ok()` - `tcx.ensure_with_value()` → `tcx.ensure_done()` - Query modifier `ensure_forwards_result_if_red` → `return_result_from_ensure_ok` Hopefully these new names are a better fit for the *actual* function and purpose of these query call modes.

Rollup of 11 pull requests Successful merges: - rust-lang#133266 (ci: fix explanation why LLVM download is disabled for windows-gnu) - rust-lang#134740 (Add amdgpu target) - rust-lang#135836 (bootstrap: only build `crt{begin,end}.o` when compiling to MUSL) - rust-lang#136154 (Use +secure-plt for powerpc-unknown-linux-gnu{,spe}) - rust-lang#136279 (Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs) - rust-lang#136283 (Update encode_utf16 to mention it is native endian) - rust-lang#136309 (set rustc dylib on manually constructed rustc command) - rust-lang#136328 (Rework "long type names" printing logic) - rust-lang#136339 (CompileTest: Add Directives to Ignore `arm-unknown-*` Targets) - rust-lang#136358 (`#[optimize(none)]` implies `#[inline(never)]`) - rust-lang#136368 (Make comma separated lists of anything easier to make for errors) r? `@ghost` `@rustbot` modify labels: rollup

Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs This is all based on my archaeology for https://rust-lang.zulipchat.com/#narrow/channel/182449-t-compiler.2Fhelp/topic/.60TyCtxtEnsure.60. The main renamings are: - `tcx.ensure()` → `tcx.ensure_ok()` - `tcx.ensure_with_value()` → `tcx.ensure_done()` - Query modifier `ensure_forwards_result_if_red` → `return_result_from_ensure_ok` Hopefully these new names are a better fit for the *actual* function and purpose of these query call modes.

Rollup of 10 pull requests Successful merges: - rust-lang#133266 (ci: fix explanation why LLVM download is disabled for windows-gnu) - rust-lang#134740 (Add amdgpu target) - rust-lang#135836 (bootstrap: only build `crt{begin,end}.o` when compiling to MUSL) - rust-lang#136279 (Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs) - rust-lang#136283 (Update encode_utf16 to mention it is native endian) - rust-lang#136309 (set rustc dylib on manually constructed rustc command) - rust-lang#136328 (Rework "long type names" printing logic) - rust-lang#136339 (CompileTest: Add Directives to Ignore `arm-unknown-*` Targets) - rust-lang#136358 (`#[optimize(none)]` implies `#[inline(never)]`) - rust-lang#136368 (Make comma separated lists of anything easier to make for errors) r? `@ghost` `@rustbot` modify labels: rollup try-job: dist-powerpc64-linux

Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs This is all based on my archaeology for https://rust-lang.zulipchat.com/#narrow/channel/182449-t-compiler.2Fhelp/topic/.60TyCtxtEnsure.60. The main renamings are: - `tcx.ensure()` → `tcx.ensure_ok()` - `tcx.ensure_with_value()` → `tcx.ensure_done()` - Query modifier `ensure_forwards_result_if_red` → `return_result_from_ensure_ok` Hopefully these new names are a better fit for the *actual* function and purpose of these query call modes.

Rollup of 5 pull requests Successful merges: - rust-lang#133266 (ci: fix explanation why LLVM download is disabled for windows-gnu) - rust-lang#135836 (bootstrap: only build `crt{begin,end}.o` when compiling to MUSL) - rust-lang#136279 (Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs) - rust-lang#136328 (Rework "long type names" printing logic) - rust-lang#136358 (`#[optimize(none)]` implies `#[inline(never)]`) r? `@ghost` `@rustbot` modify labels: rollup try-job: dist-powerpc64-linux

Rollup of 11 pull requests Successful merges: - rust-lang#133266 (ci: fix explanation why LLVM download is disabled for windows-gnu) - rust-lang#134740 (Add amdgpu target) - rust-lang#135836 (bootstrap: only build `crt{begin,end}.o` when compiling to MUSL) - rust-lang#136154 (Use +secure-plt for powerpc-unknown-linux-gnu{,spe}) - rust-lang#136279 (Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs) - rust-lang#136283 (Update encode_utf16 to mention it is native endian) - rust-lang#136309 (set rustc dylib on manually constructed rustc command) - rust-lang#136328 (Rework "long type names" printing logic) - rust-lang#136339 (CompileTest: Add Directives to Ignore `arm-unknown-*` Targets) - rust-lang#136358 (`#[optimize(none)]` implies `#[inline(never)]`) - rust-lang#136368 (Make comma separated lists of anything easier to make for errors) r? `@ghost` `@rustbot` modify labels: rollup try-job: dist-powerpc64-linux

Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs This is all based on my archaeology for https://rust-lang.zulipchat.com/#narrow/channel/182449-t-compiler.2Fhelp/topic/.60TyCtxtEnsure.60. The main renamings are: - `tcx.ensure()` → `tcx.ensure_ok()` - `tcx.ensure_with_value()` → `tcx.ensure_done()` - Query modifier `ensure_forwards_result_if_red` → `return_result_from_ensure_ok` Hopefully these new names are a better fit for the *actual* function and purpose of these query call modes.

…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#133266 (ci: fix explanation why LLVM download is disabled for windows-gnu) - rust-lang#134740 (Add amdgpu target) - rust-lang#136133 (Fix sentence in process::abort) - rust-lang#136154 (Use +secure-plt for powerpc-unknown-linux-gnu{,spe}) - rust-lang#136279 (Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs) - rust-lang#136328 (Rework "long type names" printing logic) - rust-lang#136358 (`#[optimize(none)]` implies `#[inline(never)]`) - rust-lang#136368 (Make comma separated lists of anything easier to make for errors) r? `@ghost` `@rustbot` modify labels: rollup

…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#133266 (ci: fix explanation why LLVM download is disabled for windows-gnu) - rust-lang#136133 (Fix sentence in process::abort) - rust-lang#136279 (Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs) - rust-lang#136328 (Rework "long type names" printing logic) - rust-lang#136358 (`#[optimize(none)]` implies `#[inline(never)]`) - rust-lang#136368 (Make comma separated lists of anything easier to make for errors) - rust-lang#136412 (Tweak fn pointer suggestion span) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#136279 - Zalathar:ensure-ok, r=oli-obk Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs This is all based on my archaeology for https://rust-lang.zulipchat.com/#narrow/channel/182449-t-compiler.2Fhelp/topic/.60TyCtxtEnsure.60. The main renamings are: - `tcx.ensure()` → `tcx.ensure_ok()` - `tcx.ensure_with_value()` → `tcx.ensure_done()` - Query modifier `ensure_forwards_result_if_red` → `return_result_from_ensure_ok` Hopefully these new names are a better fit for the *actual* function and purpose of these query call modes.

Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs This is all based on my archaeology for https://rust-lang.zulipchat.com/#narrow/channel/182449-t-compiler.2Fhelp/topic/.60TyCtxtEnsure.60. The main renamings are: - `tcx.ensure()` → `tcx.ensure_ok()` - `tcx.ensure_with_value()` → `tcx.ensure_done()` - Query modifier `ensure_forwards_result_if_red` → `return_result_from_ensure_ok` Hopefully these new names are a better fit for the *actual* function and purpose of these query call modes.

rustbot assigned cjgillot Jan 30, 2025

This comment has been minimized.

Sign in to view

Zalathar force-pushed the ensure-ok branch from 5879fd1 to cc238e3 Compare January 30, 2025 07:04

This comment has been minimized.

Sign in to view

Zalathar force-pushed the ensure-ok branch from cc238e3 to 35ac58e Compare January 30, 2025 07:18

This comment has been minimized.

Sign in to view

Zalathar force-pushed the ensure-ok branch from 35ac58e to 30173d1 Compare January 30, 2025 08:48

oli-obk reviewed Jan 30, 2025

View reviewed changes

compiler/rustc_middle/src/query/plumbing.rs Show resolved Hide resolved

rustbot assigned oli-obk and unassigned cjgillot Jan 30, 2025

Zalathar added 5 commits February 1, 2025 12:38

Rename tcx.ensure() to tcx.ensure_ok()

24cdaa1

Rename tcx.ensure_with_value() to tcx.ensure_done()

9e4f10d

Rename ensure_forwards_result_if_red to return_result_from_ensure_ok

fef46f4

Use an explicit type when discarding the result of tcx.ensure_ok()

3581512

Mark the tcx-ensure wrapper types with #[must_use]

3ae0239

Zalathar force-pushed the ensure-ok branch from 30173d1 to 3ae0239 Compare February 1, 2025 01:52

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 1, 2025

jhpratt mentioned this pull request Feb 1, 2025

Rollup of 11 pull requests #136378

Closed

matthiaskrgr mentioned this pull request Feb 1, 2025

Rollup of 10 pull requests #136380

Closed

matthiaskrgr mentioned this pull request Feb 1, 2025

Rollup of 5 pull requests #136386

Closed

matthiaskrgr mentioned this pull request Feb 1, 2025

Rollup of 8 pull requests #136399

Closed

matthiaskrgr mentioned this pull request Feb 2, 2025

Rollup of 7 pull requests #136433

Merged

bors merged commit 58a5f89 into rust-lang:master Feb 2, 2025
6 checks passed

rustbot added this to the 1.86.0 milestone Feb 2, 2025

Zalathar deleted the ensure-ok branch February 2, 2025 22:04

rust-timer mentioned this pull request Feb 7, 2025

Rollup of 7 pull requests #136658

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs #136279

Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs #136279

Zalathar commented Jan 30, 2025 •

edited

Loading

rustbot commented Jan 30, 2025

Zalathar commented Jan 30, 2025

This comment has been minimized.

Zalathar commented Jan 30, 2025

This comment has been minimized.

rustbot commented Jan 30, 2025

Zalathar commented Jan 30, 2025

This comment has been minimized.

oli-obk commented Jan 30, 2025

bors commented Jan 31, 2025

oli-obk commented Jan 31, 2025

Zalathar commented Feb 1, 2025

Zalathar commented Feb 1, 2025

bors commented Feb 1, 2025

Rename tcx.ensure() to tcx.ensure_ok(), and improve the associated docs #136279

Rename tcx.ensure() to tcx.ensure_ok(), and improve the associated docs #136279

Conversation

Zalathar commented Jan 30, 2025 • edited Loading

rustbot commented Jan 30, 2025

Zalathar commented Jan 30, 2025

This comment has been minimized.

Zalathar commented Jan 30, 2025

This comment has been minimized.

rustbot commented Jan 30, 2025

Zalathar commented Jan 30, 2025

This comment has been minimized.

oli-obk commented Jan 30, 2025

bors commented Jan 31, 2025

oli-obk commented Jan 31, 2025

Zalathar commented Feb 1, 2025

Zalathar commented Feb 1, 2025

bors commented Feb 1, 2025

Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs #136279

Rename `tcx.ensure()` to `tcx.ensure_ok()`, and improve the associated docs #136279

Zalathar commented Jan 30, 2025 •

edited

Loading