Skip to content
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

Specialize ToString implementation for fmt::Arguments #111168

Merged
merged 1 commit into from
May 18, 2023

Conversation

DaniPopes
Copy link
Contributor

@DaniPopes DaniPopes commented May 3, 2023

Generates far fewer instructions by formatting into a String with fmt::format directly instead of going through the fmt::Display impl. This change is insta-stable.

@rustbot
Copy link
Collaborator

rustbot commented May 3, 2023

r? @Mark-Simulacrum

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels May 3, 2023
@rustbot
Copy link
Collaborator

rustbot commented May 3, 2023

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

@rustbot rustbot added the T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. label May 3, 2023
@DaniPopes
Copy link
Contributor Author

@rustbot label +T-libs-api -T-libs

@rustbot rustbot removed the T-libs Relevant to the library team, which will review and decide on the PR/issue. label May 3, 2023
@Mark-Simulacrum
Copy link
Member

What is the user-visible impact of this specialization? Naively it seems like it should just be an internal optimization?

@rustbot author

@rustbot rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 6, 2023
@DaniPopes
Copy link
Contributor Author

Having generic std::fmt::Display or ToString arguments is a pretty common pattern, and this would allow format_args! to be more efficient than format! when ToString::to_string is called on it.

This is somewhat how I found that it was not specialized:

enum Error {
    Custom(String),
}

impl Error {
    //  or T: ToString
    fn new<T: std::fmt::Display>(t: T) -> Self {
        Self::Custom(t.to_string())
    }
}

fn main() {
    let stuff = 1234;
    let _a = Error::new(stuff);
    let _b = Error::new(format_args!("Format args: {stuff}"));
    let _c = Error::new(format!("Format: {stuff}"));
    let _d = Error::new("Str");
}

Using format! here formats into a string, passes it by value and then clones it, while format_args! formats only at the end in the ToString call, while also avoiding a clone.
This is obviously a very minor thing here but I'm sure there are other cases where format_args! is used over format!, or when lazily formatting is preferred, like in custom write!/print!-like macros.

@Mark-Simulacrum
Copy link
Member

When I say user visible I mean e.g. a test case that would fail before this change, but works after, or similar. If this is purely about performance then that's generally easier to land, as it's not something we would be blocked on reverting if we decide to go a different path in the future.

@DaniPopes
Copy link
Contributor Author

Oh sorry, I misunderstood your question. Yes, this is purely about performance, similar to #106662 and #82576, and can be undone in the future.

@DaniPopes
Copy link
Contributor Author

@rustbot review

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels May 10, 2023
@Mark-Simulacrum
Copy link
Member

@bors r+ rollup

I think this is reasonable and should be silently removable down the line (i.e., is not a stability promise).

cc @m-ou-se as well since you're working on formatting optimizations

@bors
Copy link
Contributor

bors commented May 18, 2023

📌 Commit fd80ab7 has been approved by Mark-Simulacrum

It is now in the queue for this repository.

@bors 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 May 18, 2023
bors added a commit to rust-lang-ci/rust that referenced this pull request May 18, 2023
Rollup of 7 pull requests

Successful merges:

 - rust-lang#110884 (Support RISC-V unaligned-scalar-mem target feature)
 - rust-lang#111160 (Update serde in workspace and non-synced dependencies)
 - rust-lang#111168 (Specialize ToString implementation for fmt::Arguments)
 - rust-lang#111527 (add examples of port 0 binding behavior)
 - rust-lang#111561 (Include better context for "already exists" error in compiletest)
 - rust-lang#111633 (Avoid `&format("...")` calls in error message code.)
 - rust-lang#111679 (Remove libs message about ACPs from triagebot)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit e0991b7 into rust-lang:master May 18, 2023
@rustbot rustbot added this to the 1.71.0 milestone May 18, 2023
@DaniPopes DaniPopes deleted the arguments-to-string branch May 18, 2023 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants