pw_bluetooth_proxy: Clarify MultiBufWriter::IsComplete() behavior

Change-Id: If3b9162cb9cd72f900df81b46af790d56377d88c Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/266592 Lint: Lint 🤖 <[email protected]> Docs-Not-Needed: Jonathon Reinhart <[email protected]> Presubmit-Verified: CQ Bot Account <[email protected]> Reviewed-by: David Rees <[email protected]> Pigweed-Auto-Submit: Jonathon Reinhart <[email protected]> Commit-Queue: Jonathon Reinhart <[email protected]>
google · Feb 12, 2025 · d8e5ff1 · d8e5ff1
1 parent d5e8ce4
commit d8e5ff1
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/pw_bluetooth_proxy/multibuf_writer_test.cc b/pw_bluetooth_proxy/multibuf_writer_test.cc
@@ -95,10 +95,12 @@ TEST_F(RecombinationBufferTest, CanTakeMultiBuf) {
   ASSERT_TRUE(bool(mbuf_span));
   pw::span<uint8_t> mbuf_u8_span(reinterpret_cast<uint8_t*>(mbuf_span->data()),
                                  mbuf_span->size());
-
   EXPECT_TRUE(std::equal(
       mbuf_u8_span.begin(), mbuf_u8_span.end(), kData.begin(), kData.end()));
 
+  // IsComplete() returns true
+  EXPECT_TRUE(recomb->IsComplete());
+
   // Can no longer write
   EXPECT_NE(recomb->Write(kData), OkStatus());
 

diff --git a/pw_bluetooth_proxy/public/pw_bluetooth_proxy/internal/multibuf_writer.h b/pw_bluetooth_proxy/public/pw_bluetooth_proxy/internal/multibuf_writer.h
@@ -50,14 +50,15 @@ class MultiBufWriter {
   }
 
   /// Returns true when the MultiBuf is full; i.e., when the total number of
-  /// bytes written equals the size passed to Create().
+  /// bytes written equals the size passed to Create(). Always returns true
+  /// after TakeMultiBuf() is called.
   bool IsComplete() const { return remain() == 0; }
 
   /// Consumes the underlying MultiBuf.
   ///
   /// After this method is called, this object is reset to an empty state:
   /// No data can be written, and all data accesors will return an empty
-  /// result.
+  /// result. IsComplete() will return true.
   multibuf::MultiBuf&& TakeMultiBuf() {
     write_offset_ = 0;
 
@@ -74,6 +75,9 @@ class MultiBufWriter {
 
  private:
   MultiBufWriter(multibuf::MultiBuf&& buf) : buf_(std::move(buf)) {}
+
+  /// Returns the number of bytes remaining to be written before IsComplete()
+  /// returns true.
   size_t remain() const { return buf_.size() - write_offset_; }
 
   multibuf::MultiBuf buf_;