Rename buffer_mut to next_buffer
#337
Open
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
There isn't a use-case for an immutable `buffer()` method, so the "mut" suffix is kinda unnecessary, and "next" a bit more clearly communicates that `softbuffer::Surface` potentially contains more than one buffer.
madsmtm
requested review from
MarijnS95,
ids1024 and
jackpot51
as code owners
MarijnS95
approved these changes
Feb 10, 2026
Comment on lines
29
to
+30
| /// Get a mutable reference to the buffer. | ||
| fn buffer_mut(&mut self) -> Result<Self::Buffer<'_>, SoftBufferError>; | ||
| fn next_buffer(&mut self) -> Result<Self::Buffer<'_>, SoftBufferError>; |
Member
There was a problem hiding this comment.
Is the doc-comment still "accurate" for the same "there is no immutable version" reason?
| } | ||
|
|
||
| /// Set the size of the buffer that will be returned by [`Surface::buffer_mut`]. | ||
| /// Set the size of the buffer that will be returned by [`Surface::next_buffer`]. |
Member
There was a problem hiding this comment.
Suggested change
| /// Set the size of the buffer that will be returned by [`Surface::next_buffer`]. | |
| /// Set the size of the buffer that will be returned by [`Surface::next_buffer()`]. |
etc
| - Added `Buffer::pixel_rows()` for iterating over rows of the buffer data. | ||
| - Added `Buffer::pixels_iter()` for iterating over each pixel with its associated `x`/`y` coordinate. | ||
| - Added `Buffer::byte_stride()` for pixel buffers whose rows are aligned and may contain padding bytes at the end. Prefer to use the above helpers instead of accessing pixel data directly. | ||
| - Renamed `Surface::buffer_mut` to `Surface::next_buffer`. |
Member
There was a problem hiding this comment.
Suggested change
| - Renamed `Surface::buffer_mut` to `Surface::next_buffer`. | |
| - Renamed `Surface::buffer_mut()` to `Surface::next_buffer()`. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
There isn't a use-case for an immutable
buffer()method, so the "mut" suffix is kinda unnecessary, and "next" a bit more clearly communicates thatsoftbuffer::Surfacepotentially contains more than one buffer.