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.

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

Add logging support for ProgressBar and MultiBar #44

Closed
wants to merge 2 commits into from

Conversation

steveatinfincia
Copy link

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).

@a8m
Copy link
Owner

a8m commented Feb 22, 2017

Thanks for your contribution @steveatinfincia.

This week is a bit stress for me. but I'll try to do a code review this weekend.

@stbuehler
Copy link

I think this is the wrong way to move forward.

ProgressBar should be generic over some other "Progress" trait, which can then be implemented for (some newtype wrapper for?) Write types, and also for the Pipe type. This "Progress" trait then can allow for sending progress updates and log messages.

@stbuehler
Copy link

My try getting this implemented the way I suggested: https://github.com/stbuehler/rust-pbr/tree/logging

@steveatinfincia
Copy link
Author

@stbuehler I like that idea, do you want to open another PR and i'll close this one?

@steveatinfincia
Copy link
Author

Closing in favor of #55

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants