add Progress and ProgressReader types
#10
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
aead
force-pushed
the
progress
branch
7 times, most recently
from
2f93ee1
to
826d688
Compare
This commit adds two new types for measuring progress of I/O operations. A `Progress` represents the status of an I/O operation. It contains the number of bytes read since the last progress reporting, the number of bytes processed in total so far and a potential error. The `ProgressReader` wraps an `io.Reader` and sends progress updates to its `Update` callback. By default, it calls the `Update` callback after every completed read. However, users can specify: - an `UpdateAfter` size causing the `ProgressReader` to invoke the callback once it has read at least `UpdateAfter` bytes since the last update. - an `UpdateEvery` duration causing the `ProgressReader` to invoke the callback only if no update has happened for at least `UpdateEvery` time period. Signed-off-by: Andreas Auernhammer <hi@aead.dev>
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.
This commit adds two new types for measuring
progress of I/O operations.
A
Progressrepresents the status of an I/Ooperation. It contains the number of bytes
read since the last progress reporting, the
number of bytes processed in total so far and
a potential error.
The
ProgressReaderwraps anio.Readerandsends progress updates to its
Updatecallback.By default, it calls the
Updatecallback afterevery completed read. However, users can specify:
UpdateAftersize causing theProgressReaderto invoke the callback once it has read at leastUpdateAfterbytes since the last update.UpdateEveryduration causing theProgressReaderto invoke the callback only if no update has happened for at leastUpdateEverytime period.