feat: qual of life improvements for pubkey display #164
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The rust `Display` trait has several lesser know features that can be
leveraged for making displaying public keys much nicer:
Given some public key instance, `pk`, equal to
`e2f2ae0a6abc4e71a884a961c500515f58e30b6aa582dd8db6a65945e08d2d76`,
1. truncated Width formating
`format!("{pk:16}")` gives you `e2f2ae...08d2d76`
2. Padding and fills
Widths > 64 characters let you pad and fill:
`format!("{pk:*<66}")` gives
`e2f2ae0a6abc4e71a884a961c500515f58e30b6aa582dd8db6a65945e08d2d76**`
3. Implementing lowerHex and UpperHex traits
Displaying a public key writes the lower hex by default, but you can now
specify the hex format explicitly (including using the [expected
alternate forms](https://doc.rust-lang.org/std/fmt/trait.LowerHex.html):
```rust
assert_eq!(
format!("{pk:#x}"),
"0xe2f2ae0a6abc4e71a884a961c500515f58e30b6aa582dd8db6a65945e08d2d76"
);
assert_eq!(
format!("{pk:x}"),
"e2f2ae0a6abc4e71a884a961c500515f58e30b6aa582dd8db6a65945e08d2d76"
);
assert_eq!(
format!("{pk:#X}"),
"0xE2F2AE0A6ABC4E71A884A961C500515F58E30B6AA582DD8DB6A65945E08D2D76"
);
assert_eq!(
format!("{pk:X}"),
"E2F2AE0A6ABC4E71A884A961C500515F58E30B6AA582DD8DB6A65945E08D2D76"
);
```
4. Combined formats
And of course, all these format specifiers can be combined:
```rust
assert_eq!(
format!("{pk:*^#68X}"),
"*0xE2F2AE0A6ABC4E71A884A961C500515F58E30B6AA582DD8DB6A65945E08D2D76*"
);
```
|
Should make logs a lot nicer if this is used in Tari - esp the width specifier |
|
utACK |
|
Nice |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
Formatterused in the rustDisplaytrait has several lesser-known features that can be leveraged for making displaying public keys much nicer:Given some public key instance,
pk, equal toe2f2ae0a6abc4e71a884a961c500515f58e30b6aa582dd8db6a65945e08d2d76,format!("{pk:16}")gives youe2f2ae...08d2d76format!("{pk:*<66}")givese2f2ae0a6abc4e71a884a961c500515f58e30b6aa582dd8db6a65945e08d2d76**Displaying a public key writes the lower hex by default, but you can now specify the hex format explicitly, including using the expected alternate forms:
And of course, all these format specifiers can be combined: