adding starts_with() to StringBuffer

Author: ticapix

RingBuffer/README.md

@@ -11,7 +11,8 @@ The purpose is to avoid heap fragmentation, out of memory crashes with multiple
 	buffer.append('1'); // -> return bool true |1| | |
 	buffer[0]; // -> return byte '1'
 	buffer.append("23"); // -> return bool true |1|2|3|
-	buffer.indexOf("23"); // -> return uint16_t 1
+    buffer.starts_with("23"); // -> return bool true |1|2|3|
+	buffer.index_of("23"); // -> return uint16_t 1
 	buffer.append('4'); // -> return bool false
 	buffer.full(); // -> return bool true
 	buffer.pop_first(); // return byte '1' | |2|3|

RingBuffer/RingBuffer.h

@@ -57,7 +57,9 @@ class StringBuffer: public RingBuffer<Size, byte> {
 
 	bool append(String str);
 
-	int indexOf(String substr, uint16_t offset = 0);
+	int index_of(String substr, uint16_t offset = 0);
+
+	bool starts_with(String substr);
 };
 
 /*
@@ -184,7 +186,7 @@ bool StringBuffer<Size>::append(String str) {
 }
 
 template<uint16_t Size>
-int StringBuffer<Size>::indexOf(String substr, uint16_t offset) {
+int StringBuffer<Size>::index_of(String substr, uint16_t offset) {
 	if (offset > this->length())
 		return -1;
 	if (substr.length() + offset > this->length())
@@ -200,4 +202,9 @@ int StringBuffer<Size>::indexOf(String substr, uint16_t offset) {
 	return -1;
 }
 
+template<uint16_t Size>
+bool StringBuffer<Size>::starts_with(String substr) {
+	return (this->index_of(substr) == 0);
+}
+
 #endif

tests/test-AsyncComm.cpp

@@ -142,7 +142,7 @@ TEST_F(AsyncCommTest, exec_tick) {
 	EXPECT_CALL(callbacks, clbk_executing(_)).WillOnce(
 			DoAll(WithArgs<0>(Invoke([&](decltype(callbacks)::Buffer &buff) {
 				ASSERT_EQ(len, buff.length());
-				ASSERT_EQ(buff.indexOf("OK\r\n"), 0);
+				ASSERT_EQ(buff.index_of("OK\r\n"), 0);
 				ASSERT_EQ(buff.pop_firsts(len), len);
 			})), Return(false)));
 	comm.tick();

tests/test-RingBuffer.cpp

@@ -10,11 +10,19 @@ TEST(StringBuffer, capacity) {
 
 TEST(StringBuffer, append) {
 	StringBuffer<2> buff;
-	ASSERT_EQ(buff.indexOf("1"), -1);
+	ASSERT_EQ(buff.index_of("1"), -1);
 	ASSERT_TRUE(buff.append('1'));
-	ASSERT_EQ(buff.indexOf("1"), 0);
+	ASSERT_EQ(buff.index_of("1"), 0);
 }
 
+TEST(StringBuffer, starts_with) {
+	StringBuffer<4> buff;
+	ASSERT_TRUE(buff.append("1234"));
+	ASSERT_EQ(buff.pop_first(), '1');
+	ASSERT_TRUE(buff.starts_with("234"));
+}
+
+
 TEST(StringBuffer, pop_first) {
 	StringBuffer<2> buff;
 	ASSERT_EQ(buff.length(), 0);
@@ -63,36 +71,36 @@ TEST(StringBuffer, accessor) {
 	ASSERT_EQ(buff.length(), 1);
 }
 
-TEST(StringBuffer, indexOf) {
+TEST(StringBuffer, index_of) {
 	StringBuffer<10> buff;
 	for (auto c : { '1', '2', '3', '4', 'O', 'K', 'A', 'Y', '5', '6' })
 		ASSERT_TRUE(buff.append(c));
-	ASSERT_EQ(buff.indexOf("1"), 0);
-	ASSERT_EQ(buff.indexOf("2"), 1);
-	ASSERT_EQ(buff.indexOf("12"), 0);
-	ASSERT_EQ(buff.indexOf("23"), 1);
-	ASSERT_EQ(buff.indexOf("34"), 2);
-	ASSERT_EQ(buff.indexOf("OKAY"), 4);
+	ASSERT_EQ(buff.index_of("1"), 0);
+	ASSERT_EQ(buff.index_of("2"), 1);
+	ASSERT_EQ(buff.index_of("12"), 0);
+	ASSERT_EQ(buff.index_of("23"), 1);
+	ASSERT_EQ(buff.index_of("34"), 2);
+	ASSERT_EQ(buff.index_of("OKAY"), 4);
 	ASSERT_EQ(buff.pop_first(), '1');
 	ASSERT_EQ(buff.pop_first(), '2');
-	ASSERT_EQ(buff.indexOf("OKAY"), 2);
+	ASSERT_EQ(buff.index_of("OKAY"), 2);
 	{
-		uint16_t pos = buff.indexOf("OKAY") + 4;
+		uint16_t pos = buff.index_of("OKAY") + 4;
 		while (pos--)
 			buff.pop_first();
 		ASSERT_EQ(buff.length(), 2);
 	}
-	ASSERT_EQ(buff.indexOf("56"), 0);
+	ASSERT_EQ(buff.index_of("56"), 0);
 }
 
-TEST(StringBuffer, indexOf_offset) {
+TEST(StringBuffer, index_of_offset) {
 	StringBuffer<10> buff;
 	for (auto c : { '1', '2', '3', '1', '2', '3', '1', '2', '3', '1' })
 		ASSERT_TRUE(buff.append(c));
 	int pos = 0;
 	uint16_t count = 0;
 	while (true) {
-		pos = buff.indexOf("1", pos);
+		pos = buff.index_of("1", pos);
 		if (pos == -1)
 			break;
 		ASSERT_EQ(buff[pos], '1');