General changes to Stream classes #1496
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
Contributor
mikee47
commented
Oct 18, 2018
mikee47
commented
- Move trivial code into header
- Use member variable initialisers instead of setting defaults in constructor
- Change int to unsigned/size_t as appropriate
- Change appropriate methods to const (except where there's a risk of breaking other code)
- Amend comments to clarify operation
- Mark inherited methods with virtual (if not already)
- Add ReadWriteStream::write(uint8_t) implementation to call write(const char*, size_t) method by default
mikee47
force-pushed
the
fix/Stream_improvements
branch
from
dde9e56 to
4d88b92
Compare
slaff
reviewed
Oct 20, 2018
| /** @brief Write chars to stream | ||
| * @param buffer Pointer to buffer to write to the stream | ||
| * @param size Quantity of chars to write | ||
| * @retval size_t Quantity of chars written to stream | ||
| */ | ||
| virtual size_t write(const uint8_t* buffer, size_t size); | ||
|
|
||
| virtual bool isFinished(); | ||
| /** @todo is this behaviour consistent with DataSourceStream ? |
There was a problem hiding this comment.
Remove the todo comment and leave the return value as it is for now.
* Move trivial code into header * Use member variable initialisers instead of setting defaults in constructor * Change int to unsigned/size_t as appropriate * Change appropriate methods to const (except where there's a risk of breaking other code) * Amend comments to clarify operation * Mark inherited methods with virtual (if not already) * Add ReadWriteStream::write(uint8_t) implementation to call write(const char*, size_t) method by default
mikee47
force-pushed
the
fix/Stream_improvements
branch
from
c30bf51 to
15f7622
Compare
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.