Cosmetic fixes in StringBuffer and StringBuilder

src/internal_modules/roc_address/endpoint_uri.cpp

@@ -362,7 +362,7 @@ bool EndpointUri::set_encoded_path(const char* str, size_t str_len) {
         return false;
     }
 
-    if (!b.ok()) {
+    if (!b.is_ok()) {
         set_invalid_(PartPath);
         return false;
     }

src/internal_modules/roc_address/io_uri.cpp

@@ -80,7 +80,7 @@ bool IoUri::set_encoded_path(const char* str, size_t str_len) {
         return false;
     }
 
-    if (!b.ok()) {
+    if (!b.is_ok()) {
         path_.clear();
         return false;
     }

src/internal_modules/roc_core/string_buffer.h

@@ -46,24 +46,34 @@ class StringBuffer : public NonCopyable<> {
 
     //! Copy given string into buffer.
     //! @p str should be zero-terminated.
+    //! @returns
+    //!  false if allocation failed.
     ROC_ATTR_NODISCARD bool assign(const char* str);
 
     //! Copy given range into buffer.
     //! Buffer will be automatically zero-terminated.
+    //! @returns
+    //!  false if allocation failed.
     ROC_ATTR_NODISCARD bool assign(const char* str_begin, const char* str_end);
 
     //! Extend buffer by requested number of characters.
     //! @remarks
     //!  Characters are appended to the buffer and filled with zeros.
     //!  It's the caller responsibility to fill them.
-    char* extend(size_t n_chars);
+    //! @returns
+    //!  NULL if allocation failed.
+    ROC_ATTR_NODISCARD char* extend(size_t n_chars);
 
     //! Grow capacity to be able to hold desired number of characters.
     //! Capacity is increased linearly.
+    //! @returns
+    //!  false if allocation failed.
     ROC_ATTR_NODISCARD bool grow(size_t desired_len);
 
     //! Grow capacity to be able to hold desired number of characters.
     //! Capacity is increased exponentionally.
+    //! @returns
+    //!  false if allocation failed.
     ROC_ATTR_NODISCARD bool grow_exp(size_t desired_len);
 
 private:

src/internal_modules/roc_core/string_builder.cpp

@@ -130,7 +130,7 @@ size_t StringBuilder::actual_size() const {
     return n_written_ + 1;
 }
 
-bool StringBuilder::ok() const {
+bool StringBuilder::is_ok() const {
     return !truncation_error_ && !write_error_;
 }
 
@@ -216,7 +216,7 @@ bool StringBuilder::append_(const char* str, size_t str_size, bool grow) {
         if (grow) {
             if (!writer_->grow_by(str_size)) {
                 write_error_ = true;
-                return ok();
+                return is_ok();
             }
         }
 
@@ -225,7 +225,7 @@ bool StringBuilder::append_(const char* str, size_t str_size, bool grow) {
 
             if (write_size < 0) {
                 write_error_ = true;
-                return ok();
+                return is_ok();
             }
 
             if (write_size > 0) {
@@ -241,7 +241,7 @@ bool StringBuilder::append_(const char* str, size_t str_size, bool grow) {
         }
     }
 
-    return ok();
+    return is_ok();
 }
 
 } // namespace core

src/internal_modules/roc_core/string_builder.h

@@ -73,11 +73,10 @@ class StringBuilder : public NonCopyable<> {
     size_t actual_size() const;
 
     //! Check for errors.
-    //!
-    //! @remark
-    //!  Error flag is raised if any of the methods fail, and is resetted
+    //! @remarks
+    //!  Error flag is raised if any of the methods fail, and is cleared
     //!  if an assign* method succeeds.
-    bool ok() const;
+    bool is_ok() const;
 
     //! Overwrite result with given string.
     //! If there is not enough space, truncates the string and returns false.

src/internal_modules/roc_netio/target_libuv/roc_netio/basic_port.cpp

@@ -34,7 +34,7 @@ void BasicPort::update_descriptor() {
 
     format_descriptor(b);
 
-    if (!b.ok() || b.actual_size() == 0) {
+    if (!b.is_ok() || b.actual_size() == 0) {
         roc_panic("basic port: failed to format descriptor");
     }
 }

src/public_api/src/endpoint.cpp

@@ -152,7 +152,7 @@ int roc_endpoint_get_uri(const roc_endpoint* endpoint, char* buf, size_t* bufsz)
         return -1;
     }
 
-    if (!b.ok()) {
+    if (!b.is_ok()) {
         roc_log(LogError,
                 "roc_endpoint_get_uri(): buffer too small: provided=%lu needed=%lu",
                 (unsigned long)*bufsz, (unsigned long)b.needed_size());
@@ -213,7 +213,7 @@ int roc_endpoint_get_host(const roc_endpoint* endpoint, char* buf, size_t* bufsz
         return -1;
     }
 
-    if (!b.ok()) {
+    if (!b.is_ok()) {
         roc_log(LogError,
                 "roc_endpoint_get_host(): buffer too small: provided=%lu needed=%lu",
                 (unsigned long)*bufsz, (unsigned long)b.needed_size());
@@ -269,7 +269,7 @@ int roc_endpoint_get_resource(const roc_endpoint* endpoint, char* buf, size_t* b
         return -1;
     }
 
-    if (!b.ok()) {
+    if (!b.is_ok()) {
         roc_log(LogError,
                 "roc_endpoint_get_resource(): buffer too small: provided=%lu needed=%lu",
                 (unsigned long)*bufsz, (unsigned long)b.needed_size());

src/tests/roc_address/test_endpoint_uri.cpp

@@ -468,14 +468,14 @@ TEST(endpoint_uri, small_buffer) {
         core::StringBuilder b(buf, sizeof(buf));
 
         CHECK(format_endpoint_uri(u, EndpointUri::Subset_Full, b));
-        CHECK(b.ok());
+        CHECK(b.is_ok());
     }
 
     for (size_t i = 0; i < sizeof(buf); i++) {
         core::StringBuilder b(buf, i);
 
         CHECK(format_endpoint_uri(u, EndpointUri::Subset_Full, b));
-        CHECK(!b.ok());
+        CHECK(!b.is_ok());
     }
 }
 

src/tests/roc_address/test_io_uri.cpp

@@ -190,14 +190,14 @@ TEST(io_uri, small_buffer) {
         core::StringBuilder b(buf, sizeof(buf));
 
         CHECK(format_io_uri(u, b));
-        CHECK(b.ok());
+        CHECK(b.is_ok());
     }
 
     for (size_t i = 0; i < sizeof(buf); i++) {
         core::StringBuilder b(buf, i);
 
         CHECK(format_io_uri(u, b));
-        CHECK(!b.ok());
+        CHECK(!b.is_ok());
     }
 }
 

src/tests/roc_address/test_pct.cpp

@@ -23,7 +23,7 @@ ssize_t encode(char* dst, size_t dst_sz, const char* src, size_t src_sz, PctMode
         return -1;
     }
 
-    if (!b.ok()) {
+    if (!b.is_ok()) {
         return -1;
     }
 
@@ -37,7 +37,7 @@ ssize_t decode(char* dst, size_t dst_sz, const char* src, size_t src_sz) {
         return -1;
     }
 
-    if (!b.ok()) {
+    if (!b.is_ok()) {
         return -1;
     }
 

src/tests/roc_core/test_hashmap.cpp

@@ -67,7 +67,7 @@ TEST_GROUP(hashmap) {
         StringBuilder b(key, keysz);
         CHECK(b.append_str("key"));
         CHECK(b.append_uint((uint64_t)n, 10));
-        CHECK(b.ok());
+        CHECK(b.is_ok());
     }
 
     template <size_t Capacity> void test_embedded_capacity() {