Please support painting bytes (&[u8]) #19
Merged
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
|
Yeah, this is something I'd like to do (and your use case is exactly it). |
|
I have this mostly implemented; I'm working on test cases right now. |
Applications working with text in unknown or non-UTF-8 character sets need to handle that text as opaque [u8] bytestrings. For example, git diffs from git2-rs provide the diff text as [u8] bytestrings, because the files diffed might not use UTF-8. Add support for painting [u8] bytestrings, producing a new ANSIByteString type. Add an ANSIByteStrings type to print many ANSIByteString values with minimal escape sequences. To avoid duplicating code for str and [u8], introduce generic versions of ANSIString and ANSIStrings, with the specific versions for str and [u8] as type aliases. Also introduce a private trait AnyWrite to abstract code that works with either fmt::Write and io::Write. This implementation provides full source compatibility with code written for previous versions of ansi_term. All the existing tests pass unmodified. Nonetheless, this should likely bump the version to 0.9.0, because the introduction of generic types may potentially affect type inference. Extend the testsuite to run all the tests on ANSIByteString, as well.
|
I just attached a pull request implementing this. |
|
Published as v0.9.0. |
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.
ansi_term currently only supports painting strings (
Stringor&str). Sometimes, to handle text in unknown character sets, a program will need to emit raw bytes; for instance, git diffs from git2-rs provide the diff text as bytes, because the files diffed might not use UTF-8. I'd like to render diffs with color using ansi_term.Please consider adding support to paint bytes with a Colour or Style, perhaps via a new
paint_bytesmethod. This would need to return a new type likeANSIBytes, which couldn't implementDisplay, but which could support writing to astd::io::Writevia.write_all.