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.

Sign up for GitHub

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

Jump to bottom

Audit fmt::{Display,Debug} implementations (also rename from String/Show) #21436

Closed
alexcrichton opened this issue Jan 20, 2015 · 0 comments · Fixed by #21457
Closed

Audit fmt::{Display,Debug} implementations (also rename from String/Show) #21436

alexcrichton opened this issue Jan 20, 2015 · 0 comments · Fixed by #21457
Assignees
@alexcrichton
Labels
B-RFC-approved Blocker: Approved by a merged RFC but not yet implemented.

Comments

@alexcrichton
Copy link
Member

Tracking issue for rust-lang/rfcs#565

I'll be working on this soon.
@alexcrichton alexcrichton added the B-RFC-approved Blocker: Approved by a merged RFC but not yet implemented. label Jan 20, 2015
@alexcrichton alexcrichton self-assigned this Jan 20, 2015
@alexcrichton alexcrichton mentioned this issue Jan 21, 2015
Merged
alexcrichton added a commit to alexcrichton/rust that referenced this issue Jan 21, 2015
@alexcrichton
std: Rename Show/String to Debug/Display
3cb9fa2 
This commit is an implementation of [RFC 565][rfc] which is a stabilization of
the `std::fmt` module and the implementations of various formatting traits.
Specifically, the following changes were performed:

[rfc]: https://github.com/rust-lang/rfcs/blob/master/text/0565-show-string-guidelines.md

* The `Show` trait is now deprecated, it was renamed to `Debug`
* The `String` trait is now deprecated, it was renamed to `Display`
* Many `Debug` and `Display` implementations were audited in accordance with the
  RFC and audited implementations now have the `#[stable]` attribute
  * Integers and floats no longer print a suffix
  * Smart pointers no longer print details that they are a smart pointer
  * Paths with `Debug` are now quoted and escape characters
* The `unwrap` methods on `Result` now require `Display` instead of `Debug`
* The `Error` trait no longer has a `detail` method and now requires that
  `Display` must be implemented. With the loss of `String`, this has moved into
  libcore.
* `impl<E: Error> FromError<E> for Box<Error>` now exists
* `derive(Show)` has been renamed to `derive(Debug)`. This is not currently
  warned about due to warnings being emitted on stage1+

While backwards compatibility is attempted to be maintained with a blanket
implementation of `Display` for the old `String` trait (and the same for
`Show`/`Debug`) this is still a breaking change due to primitives no longer
implementing `String` as well as modifications such as `unwrap` and the `Error`
trait. Most code is fairly straightforward to update with a rename or tweaks of
method calls.

[breaking-change]
Closes rust-lang#21436
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alexcrichton alexcrichton

Labels
B-RFC-approved Blocker: Approved by a merged RFC but not yet implemented.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

std: Rename Show/String to Debug/Display alexcrichton/rust
1 participant
@alexcrichton