pw_status: Replace Status::Ok() with OkStatus()
- Mark Status::Ok() and StatusWithSize::Ok() as deprecated.
- Replace Status::Ok() with OkStatus().
- Replace StatusWithSize::Ok() with StatusWithSize().
Change-Id: If7192282446bf6d7f90990bb0b4f1b1b89a9228a
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/29003
Pigweed-Auto-Submit: Wyatt Hepler <hepler@google.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed.google.com.iam.gserviceaccount.com>
Reviewed-by: Keir Mierle <keir@google.com>
diff --git a/pw_string/format_test.cc b/pw_string/format_test.cc
index b7aab52..9aef419 100644
--- a/pw_string/format_test.cc
+++ b/pw_string/format_test.cc
@@ -26,7 +26,7 @@
char buffer[32];
auto result = Format(buffer, "-_-");
- EXPECT_EQ(Status::Ok(), result.status());
+ EXPECT_EQ(OkStatus(), result.status());
EXPECT_EQ(3u, result.size());
EXPECT_STREQ("-_-", buffer);
}
@@ -35,7 +35,7 @@
char buffer[32];
auto result = Format(buffer, "%d4%s", 123, "5");
- EXPECT_EQ(Status::Ok(), result.status());
+ EXPECT_EQ(OkStatus(), result.status());
EXPECT_EQ(5u, result.size());
EXPECT_STREQ("12345", buffer);
}
@@ -81,7 +81,7 @@
char buffer[8];
auto result = CallFormatWithVaList(buffer, "Yo%s", "?!");
- EXPECT_EQ(Status::Ok(), result.status());
+ EXPECT_EQ(OkStatus(), result.status());
EXPECT_EQ(4u, result.size());
EXPECT_STREQ("Yo?!", buffer);
}
diff --git a/pw_string/public/pw_string/format.h b/pw_string/public/pw_string/format.h
index f3aa337..9499eb2 100644
--- a/pw_string/public/pw_string/format.h
+++ b/pw_string/public/pw_string/format.h
@@ -35,7 +35,7 @@
//
// The status is
//
-// Status::Ok() if the operation succeeded,
+// OkStatus() if the operation succeeded,
// Status::ResourceExhausted() if the buffer was too small to fit the output,
// Status::InvalidArgument() if there was a formatting error.
//
diff --git a/pw_string/public/pw_string/string_builder.h b/pw_string/public/pw_string/string_builder.h
index 425fbfb..7d2c5a4 100644
--- a/pw_string/public/pw_string/string_builder.h
+++ b/pw_string/public/pw_string/string_builder.h
@@ -135,7 +135,7 @@
// The status from the last operation. May be OK while status() is not OK.
Status last_status() const { return last_status_; }
- // True if status() is Status::Ok().
+ // True if status() is OkStatus().
bool ok() const { return status_.ok(); }
// True if the string is empty.
@@ -150,10 +150,10 @@
// Clears the string and resets its error state.
void clear();
- // Sets the statuses to Status::Ok();
+ // Sets the statuses to OkStatus();
void clear_status() {
- status_ = Status::Ok();
- last_status_ = Status::Ok();
+ status_ = OkStatus();
+ last_status_ = OkStatus();
}
// Appends a single character. Stets the status to RESOURCE_EXHAUSTED if the
diff --git a/pw_string/string_builder.cc b/pw_string/string_builder.cc
index 1bc3b1f..60879a9 100644
--- a/pw_string/string_builder.cc
+++ b/pw_string/string_builder.cc
@@ -24,8 +24,8 @@
void StringBuilder::clear() {
size_ = 0;
NullTerminate();
- status_ = Status::Ok();
- last_status_ = Status::Ok();
+ status_ = OkStatus();
+ last_status_ = OkStatus();
}
StringBuilder& StringBuilder::append(size_t count, char ch) {
@@ -70,7 +70,7 @@
if (buffer_.empty() || chars_to_append != copied) {
SetErrorStatus(Status::ResourceExhausted());
} else {
- last_status_ = Status::Ok();
+ last_status_ = OkStatus();
}
return copied;
}
@@ -79,7 +79,7 @@
if (new_size <= size_) {
size_ = new_size;
NullTerminate();
- last_status_ = Status::Ok();
+ last_status_ = OkStatus();
} else {
SetErrorStatus(Status::OutOfRange());
}
diff --git a/pw_string/string_builder_test.cc b/pw_string/string_builder_test.cc
index cfef0e7..22378cc 100644
--- a/pw_string/string_builder_test.cc
+++ b/pw_string/string_builder_test.cc
@@ -102,8 +102,8 @@
TEST(StringBuilder, EmptyBuffer_AppendEmpty_ResourceExhausted) {
StringBuilder sb(std::span<char>{});
- EXPECT_EQ(Status::Ok(), sb.last_status());
- EXPECT_EQ(Status::Ok(), sb.status());
+ EXPECT_EQ(OkStatus(), sb.last_status());
+ EXPECT_EQ(OkStatus(), sb.status());
sb << "";
@@ -113,8 +113,8 @@
TEST(StringBuilder, Status_StartsOk) {
StringBuffer<16> sb;
- EXPECT_EQ(Status::Ok(), sb.status());
- EXPECT_EQ(Status::Ok(), sb.last_status());
+ EXPECT_EQ(OkStatus(), sb.status());
+ EXPECT_EQ(OkStatus(), sb.last_status());
}
TEST(StringBuilder, Status_StatusAndLastStatusUpdate) {
@@ -129,7 +129,7 @@
sb << "";
EXPECT_EQ(Status::OutOfRange(), sb.status());
- EXPECT_EQ(Status::Ok(), sb.last_status());
+ EXPECT_EQ(OkStatus(), sb.last_status());
}
TEST(StringBuilder, Status_ClearStatus_SetsStatuesToOk) {
@@ -138,8 +138,8 @@
EXPECT_EQ(Status::ResourceExhausted(), sb.last_status());
sb.clear_status();
- EXPECT_EQ(Status::Ok(), sb.status());
- EXPECT_EQ(Status::Ok(), sb.last_status());
+ EXPECT_EQ(OkStatus(), sb.status());
+ EXPECT_EQ(OkStatus(), sb.last_status());
}
TEST(StringBuilder, StreamOutput_OutputSelf) {
@@ -153,7 +153,7 @@
TEST(StringBuilder, PushBack) {
StringBuffer<12> sb;
sb.push_back('?');
- EXPECT_EQ(Status::Ok(), sb.last_status());
+ EXPECT_EQ(OkStatus(), sb.last_status());
EXPECT_EQ(1u, sb.size());
EXPECT_STREQ("?", sb.data());
}
@@ -168,7 +168,7 @@
TEST(StringBuilder, PopBack) {
auto sb = MakeString<12>("Welcome!");
sb.pop_back();
- EXPECT_EQ(Status::Ok(), sb.last_status());
+ EXPECT_EQ(OkStatus(), sb.last_status());
EXPECT_EQ(7u, sb.size());
EXPECT_STREQ("Welcome", sb.data());
}
@@ -362,7 +362,7 @@
constexpr std::string_view hello("hello");
buffer << hello;
- EXPECT_EQ(Status::Ok(), buffer.status());
+ EXPECT_EQ(OkStatus(), buffer.status());
EXPECT_STREQ("hello", buffer.data());
}
@@ -422,7 +422,7 @@
two << "";
ASSERT_STREQ("What heck", two.data());
ASSERT_EQ(Status::ResourceExhausted(), two.status());
- ASSERT_EQ(Status::Ok(), two.last_status());
+ ASSERT_EQ(OkStatus(), two.last_status());
}
TEST(StringBuffer, CopyConstructFromSmaller) {
diff --git a/pw_string/to_string_test.cc b/pw_string/to_string_test.cc
index 2f3608d..347010a 100644
--- a/pw_string/to_string_test.cc
+++ b/pw_string/to_string_test.cc
@@ -101,7 +101,7 @@
auto result = ToString(MyEnum::kLuckyNumber, buffer);
EXPECT_EQ(1u, result.size());
- EXPECT_EQ(Status::Ok(), result.status());
+ EXPECT_EQ(OkStatus(), result.status());
EXPECT_STREQ("8", buffer);
}
diff --git a/pw_string/type_to_string.cc b/pw_string/type_to_string.cc
index 483d10e..4872504 100644
--- a/pw_string/type_to_string.cc
+++ b/pw_string/type_to_string.cc
@@ -190,7 +190,7 @@
buffer[copied] = '\0';
return StatusWithSize(
- copied == value.size() ? Status::Ok() : Status::ResourceExhausted(),
+ copied == value.size() ? OkStatus() : Status::ResourceExhausted(),
copied);
}