Add logging support for ProgressBar and MultiBar #44
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.
Hello :)
I have added simple logging support to ProgressBar and MultiBar, hopefully in a way that doesn't cause issues for anyone who doesn't need it.
Log messages are printed above the bar area and appear to move upward with each new log message, as you would expect.
To allow ProgressBar to log messages when part of a MultiBar without significantly changing the way they are implemented, I have borrowed a trick from HTTP multipart/form-data and added an optional boundary string to Pipe.
If that boundary string is included in a string sent across the Pipe to MultiBar, the string is split and the first section is treated as a log message, the second is the bar string. If no boundary is sent, it should operate exactly the same as it did before.
I considered adding support for integration with the
log
crate, formatting, colors, and a way to present a virtual "log window" where the messages disappear at the top rather than continuing to scroll, but this seemed like a good start and those can be added later if necessary.All the existing tests pass, though some of the failing doc tests look like they were never intended to pass (missing variables).