1
Fork 0

Add hexadecimal formatting of integers with fmt::Debug

This can be used for integers within a larger types which implements Debug
(possibly through derive) but not fmt::UpperHex or fmt::LowerHex.

```rust
assert!(format!("{:02x?}", b"Foo\0") == "[46, 6f, 6f, 00]");
assert!(format!("{:02X?}", b"Foo\0") == "[46, 6F, 6F, 00]");
```

RFC: https://github.com/rust-lang/rfcs/pull/2226
This commit is contained in:
Simon Sapin 2018-03-13 14:08:15 +01:00
parent 883e74645d
commit 4897935e86
5 changed files with 42 additions and 4 deletions

View file

@ -113,6 +113,8 @@
//! //!
//! * *nothing* ⇒ [`Display`] //! * *nothing* ⇒ [`Display`]
//! * `?` ⇒ [`Debug`] //! * `?` ⇒ [`Debug`]
//! * `x?` ⇒ [`Debug`] with lower-case hexadecimal integers
//! * `X?` ⇒ [`Debug`] with lower-case hexadecimal integers
//! * `o` ⇒ [`Octal`](trait.Octal.html) //! * `o` ⇒ [`Octal`](trait.Octal.html)
//! * `x` ⇒ [`LowerHex`](trait.LowerHex.html) //! * `x` ⇒ [`LowerHex`](trait.LowerHex.html)
//! * `X` ⇒ [`UpperHex`](trait.UpperHex.html) //! * `X` ⇒ [`UpperHex`](trait.UpperHex.html)

View file

@ -333,7 +333,7 @@ impl<'a> ArgumentV1<'a> {
// flags available in the v1 format of format_args // flags available in the v1 format of format_args
#[derive(Copy, Clone)] #[derive(Copy, Clone)]
enum FlagV1 { SignPlus, SignMinus, Alternate, SignAwareZeroPad, } enum FlagV1 { SignPlus, SignMinus, Alternate, SignAwareZeroPad, DebugLowerHex, DebugUpperHex }
impl<'a> Arguments<'a> { impl<'a> Arguments<'a> {
/// When using the format_args!() macro, this function is used to generate the /// When using the format_args!() macro, this function is used to generate the
@ -1401,6 +1401,12 @@ impl<'a> Formatter<'a> {
self.flags & (1 << FlagV1::SignAwareZeroPad as u32) != 0 self.flags & (1 << FlagV1::SignAwareZeroPad as u32) != 0
} }
// FIXME: Decide what public API we want for these two flags.
// https://github.com/rust-lang/rust/issues/48584
fn debug_lower_hex(&self) -> bool { self.flags & (1 << FlagV1::DebugLowerHex as u32) != 0 }
fn debug_upper_hex(&self) -> bool { self.flags & (1 << FlagV1::DebugUpperHex as u32) != 0 }
/// Creates a [`DebugStruct`] builder designed to assist with creation of /// Creates a [`DebugStruct`] builder designed to assist with creation of
/// [`fmt::Debug`] implementations for structs. /// [`fmt::Debug`] implementations for structs.
/// ///

View file

@ -159,11 +159,17 @@ macro_rules! debug {
impl fmt::Debug for $T { impl fmt::Debug for $T {
#[inline] #[inline]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
if f.debug_lower_hex() {
fmt::LowerHex::fmt(self, f)
} else if f.debug_upper_hex() {
fmt::UpperHex::fmt(self, f)
} else {
fmt::Display::fmt(self, f) fmt::Display::fmt(self, f)
} }
} }
} }
} }
}
macro_rules! integer { macro_rules! integer {
($Int:ident, $Uint:ident) => { ($Int:ident, $Uint:ident) => {

View file

@ -150,3 +150,9 @@ fn test_format_int_twos_complement() {
assert!(format!("{}", i32::MIN) == "-2147483648"); assert!(format!("{}", i32::MIN) == "-2147483648");
assert!(format!("{}", i64::MIN) == "-9223372036854775808"); assert!(format!("{}", i64::MIN) == "-9223372036854775808");
} }
#[test]
fn test_format_debug_hex() {
assert!(format!("{:02x?}", b"Foo\0") == "[46, 6f, 6f, 00]");
assert!(format!("{:02X?}", b"Foo\0") == "[46, 6F, 6F, 00]");
}

View file

@ -108,6 +108,10 @@ pub enum Flag {
/// For numbers, this means that the number will be padded with zeroes, /// For numbers, this means that the number will be padded with zeroes,
/// and the sign (`+` or `-`) will precede them. /// and the sign (`+` or `-`) will precede them.
FlagSignAwareZeroPad, FlagSignAwareZeroPad,
/// For Debug / `?`, format integers in lower-case hexadecimal.
FlagDebugLowerHex,
/// For Debug / `?`, format integers in upper-case hexadecimal.
FlagDebugUpperHex,
} }
/// A count is used for the precision and width parameters of an integer, and /// A count is used for the precision and width parameters of an integer, and
@ -377,8 +381,22 @@ impl<'a> Parser<'a> {
spec.precision = self.count(); spec.precision = self.count();
} }
} }
// Finally the actual format specifier // Optional radix followed by the actual format specifier
if self.consume('x') {
if self.consume('?') { if self.consume('?') {
spec.flags |= 1 << (FlagDebugLowerHex as u32);
spec.ty = "?";
} else {
spec.ty = "x";
}
} else if self.consume('X') {
if self.consume('?') {
spec.flags |= 1 << (FlagDebugUpperHex as u32);
spec.ty = "?";
} else {
spec.ty = "X";
}
} else if self.consume('?') {
spec.ty = "?"; spec.ty = "?";
} else { } else {
spec.ty = self.word(); spec.ty = self.word();