Add getLines method.

README.md

@@ -100,6 +100,7 @@ If there are any issues with <b>complexity</b> please <b>open an issue</b>
 | reverse            | Reverses all the characters                                              |
 | split              | Returns a slice based on delimiters                                      |
 | splitToString      | Returns a String based on delimiters                                     |
+| lines              | Returns a slice of Strings split by newlines                             |
 | str                | Returns the String as a slice                                            |
 | substr             | Creates a string from a range                                            |
 | toLowercase        | Converts (ASCII) characters to lowercase                                 |

zig-string-tests.zig

@@ -137,6 +137,17 @@ test "String Tests" {
 
     try expectEqualStrings(newSplit.?.str(), "variable");
 
+    // lines
+    const lineSlice = "Line0\r\nLine1\nLine2";
+
+    var lineStr = try String.init_with_contents(arena.allocator(), lineSlice);
+    var linesSlice = try lineStr.lines();
+
+    try expectEqual(linesSlice.len, 3);
+    try expect(linesSlice[0].cmp("Line0"));
+    try expect(linesSlice[1].cmp("Line1"));
+    try expect(linesSlice[2].cmp("Line2"));
+
     // toLowercase & toUppercase
     myStr.toUppercase();
     try expect(myStr.cmp("💯HELLO💯💯HELLO💯💯HELLO💯"));

zig-string.zig

@@ -373,6 +373,24 @@ pub const String = struct {
         return null;
     }
 
+    /// Splits the String into a slice of Strings by new line (\r\n or \n).
+    pub fn lines(self: *String) ![]String {
+        var lineArr = std.ArrayList(String).init(std.heap.page_allocator);
+        defer lineArr.deinit();
+
+        var selfClone = try self.clone();
+        defer selfClone.deinit();
+
+        _ = try selfClone.replace("\r\n", "\n");
+
+        var i: usize = 0;
+        while (try selfClone.splitToString("\n", i)) |line| : (i += 1) {
+            try lineArr.append(line);
+        }
+
+        return try lineArr.toOwnedSlice();
+    }
+
     /// Clears the contents of the String but leaves the capacity
     pub fn clear(self: *String) void {
         if (self.buffer) |buffer| {