Skip to content

Commit 66f7ece

Browse files
authored
Unrolled build for #145943
Rollup merge of #145943 - dianne:format-args-assign-docs, r=joboet stdlib docs: document lifetime extension for `format_args!`'s arguments Since #140748 is stable and #92698 is closed, the section about `format_args!`'s argument lifetime limitation is outdated. I've updated it to point to the Reference docs, which will specify lifetime extension rules for builtin macros once rust-lang/reference#1980 or equivalent is merged. I've also taken the liberty of updating one of the doctests to assign the result of `format_args!` to a variable, both to provide an example and because I think it reads a little better. r? `@m-ou-se`
2 parents fed46ff + ee9986b commit 66f7ece

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

library/core/src/macros/mod.rs

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -951,8 +951,9 @@ pub(crate) mod builtin {
951951
/// format string in `format_args!`.
952952
///
953953
/// ```rust
954-
/// let debug = format!("{:?}", format_args!("{} foo {:?}", 1, 2));
955-
/// let display = format!("{}", format_args!("{} foo {:?}", 1, 2));
954+
/// let args = format_args!("{} foo {:?}", 1, 2);
955+
/// let debug = format!("{args:?}");
956+
/// let display = format!("{args}");
956957
/// assert_eq!("1 foo 2", display);
957958
/// assert_eq!(display, debug);
958959
/// ```
@@ -976,13 +977,17 @@ pub(crate) mod builtin {
976977
/// assert_eq!(s, format!("hello {}", "world"));
977978
/// ```
978979
///
979-
/// # Lifetime limitation
980+
/// # Argument lifetimes
980981
///
981982
/// Except when no formatting arguments are used,
982-
/// the produced `fmt::Arguments` value borrows temporary values,
983-
/// which means it can only be used within the same expression
984-
/// and cannot be stored for later use.
985-
/// This is a known limitation, see [#92698](https://github.com/rust-lang/rust/issues/92698).
983+
/// the produced `fmt::Arguments` value borrows temporary values.
984+
/// To allow it to be stored for later use, the arguments' lifetimes, as well as those of
985+
/// temporaries they borrow, may be [extended] when `format_args!` appears in the initializer
986+
/// expression of a `let` statement. The syntactic rules used to determine when temporaries'
987+
/// lifetimes are extended are documented in the [Reference].
988+
///
989+
/// [extended]: ../reference/destructors.html#temporary-lifetime-extension
990+
/// [Reference]: ../reference/destructors.html#extending-based-on-expressions
986991
#[stable(feature = "rust1", since = "1.0.0")]
987992
#[rustc_diagnostic_item = "format_args_macro"]
988993
#[allow_internal_unsafe]

0 commit comments

Comments
 (0)