This repository was archived by the owner on Dec 13, 2023. It is now read-only.
feat: Add generic progress emitter utility #141
Merged
Conversation
This file contains hidden or 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
This adds a generic utility which can be used to track progress of data transfers by emitting progress via a tokio broadcast channel.
Also adds some tests.
| /// The emitter expects to see *total* being added via [`ProgressEmitter::inc`] and will | ||
| /// emit *steps* updates. | ||
| pub fn new(total: u64, steps: u16) -> Self { | ||
| let (tx, _rx) = broadcast::channel(16); |
There was a problem hiding this comment.
should this 16 be configurable?
There was a problem hiding this comment.
My opiniated answer is: no. At least not until someone has a good usecase.
My reasoning:
Firstly, you should be able to keep up: spawn a task.
Secondly it is only a progress report. If you happen to hit the RecvErr::Lagged branch you still have access to the most up to date progress. The historical progress updates are not really useful anymore, there is not event a timestamp associated with them.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This adds a generic utility which can be used to track progress of
data transfers by emitting progress via a tokio broadcast channel.
This is extracted from the deltachat PR:
chatmail/core#4007