task() unmanaged string impl.

Author: definitepotato

README.md

@@ -1,26 +1,24 @@
 # Zig String (A UTF-8 String Library)
 
-[![CI](https://github.com/JakubSzark/zig-string/actions/workflows/main.yml/badge.svg)](https://github.com/JakubSzark/zig-string/actions/workflows/main.yml) ![Github Repo Issues](https://img.shields.io/github/issues/JakubSzark/zig-string?style=flat) ![GitHub Repo stars](https://img.shields.io/github/stars/JakubSzark/zig-string?style=social)
-
-This library is a UTF-8 compatible **string** library for the **Zig** programming language.
-I made this for the sole purpose to further my experience and understanding of zig.
-Also it may be useful for some people who need it (including myself), with future projects. Project is also open for people to add to and improve. Please check the **issues** to view requested features.
+This library is a UTF-8 compatible **string** library for the **Zig** programming language. I copied [JakubSzark's](https://github.com/JakubSzark/zig-string) String implementation and expanded on it.
 
 # Basic Usage
 
 ## Managed String
 
 ```zig
 const std = @import("std");
-const String = @import("./zig-string.zig").String;
+const String = @import("./stringz.zig").StringManaged;
 // ...
 
 // Use your favorite allocator
 var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
 defer arena.deinit();
+const allocator = arena.allocator();
+
 
 // Create your String
-var myString = String.init(arena.allocator());
+var myString = String.init(allocator);
 defer myString.deinit();
 
 // Use functions provided
@@ -37,21 +35,22 @@ std.debug.assert(myString.cmp("🔥 Hello, World 🔥"));
 
 ```zig
 const std = @import("std");
-const StringUnmanaged = @import("./zig-string.zig").StringUnmanaged;
+const String = @import("./stringz.zig").StringUnmanaged;
 // ...
 
 // Use your favorite allocator
 var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
 defer arena.deinit();
+const allocator = arena.allocator();
 
 // Create your String
 var myString = String.init();
-defer myString.deinit(arena.allocator());
+defer myString.deinit(allocator);
 
 // Use functions provided
-try myString.concat(arena.allocator(), "🔥 Hello!");
+try myString.concat(allocator, "🔥 Hello!");
 _ = myString.pop();
-try myString.concat(arena.allocator(), ", World 🔥");
+try myString.concat(allocator, ", World 🔥");
 
 // Success!
 std.debug.assert(myString.cmp("🔥 Hello, World 🔥"));
@@ -60,7 +59,7 @@ std.debug.assert(myString.cmp("🔥 Hello, World 🔥"));
 
 ## When To Use Which?
 
-If simplicity is what you want and you don't need granular control over memory, then use `String` (this is fine for most cases). Otherwise you probably want `StringUnmanaged`.
+If simplicity is what you want and you don't need granular control over memory, then use `StringManaged` (this is fine for most cases). Otherwise you probably want `StringUnmanaged`.
 
 | Feature                         | String | StringUnmanaged            |
 | ------------------------------- | ------ | -------------------------- |
@@ -76,8 +75,8 @@ Add this to your build.zig.zon
 ```zig
 .dependencies = .{
     .string = .{
-        .url = "https://github.com/JakubSzark/zig-string/archive/refs/heads/master.tar.gz",
-        //the correct hash will be suggested by zig
+        .url = "https://github.com/definitepotato/stringz/archive/refs/heads/master.tar.gz",
+        // The correct hash will be suggested by zig at build time.
     }
 }
 
@@ -86,19 +85,24 @@ Add this to your build.zig.zon
 And add this to you build.zig
 
 ```zig
-    const string = b.dependency("string", .{
+    const string = b.dependency("stringz", .{
         .target = target,
         .optimize = optimize,
     });
-    exe.root_module.addImport("string", string.module("string"));
+    exe.root_module.addImport("stringz", string.module("stringz"));
 
 ```
 
 You can then import the library into your code like this
 
 ```zig
-const String = @import("string").String;
-const StringUnmanaged = @import("string").StringUnmanaged;
+const String = @import("stringz").StringManaged;
+```
+
+Or
+
+```zig
+const String = @import("stringz").StringUnmanaged;
 ```
 
 # How to Contribute

build.zig

@@ -4,10 +4,10 @@ pub fn build(b: *std.Build) void {
     const target = b.standardTargetOptions(.{});
     const optimize = b.standardOptimizeOption(.{});
 
-    _ = b.addModule("string", .{ .root_source_file = b.path("zig-string.zig") });
+    _ = b.addModule("string", .{ .root_source_file = b.path("stringz.zig") });
 
     var main_tests = b.addTest(.{
-        .root_source_file = b.path("zig-string-tests.zig"),
+        .root_source_file = b.path("stringz-tests.zig"),
         .target = target,
         .optimize = optimize,
     });

build.zig.zon

@@ -1,7 +1,7 @@
 .{
-    .name = .zig_string,
+    .name = .stringz,
     .version = "0.10.0",
     .minimum_zig_version = "0.14.0",
-    .fingerprint = 0xd2ee692e5a4bdae9,
+    .fingerprint = 0xcd46d25165d43c8a,
     .paths = .{""},
 }

zig-string-tests.zig renamed to stringz-tests.zig

@@ -3,12 +3,12 @@ const expect = std.testing.expect;
 const expectEqual = std.testing.expectEqual;
 const expectEqualStrings = std.testing.expectEqualStrings;
 
-const String = @import("stringz.zig").String;
+const StringManaged = @import("stringz.zig").StringManaged;
 const StringUnmanaged = @import("stringz.zig").StringUnmanaged;
 
-test "String Basic Usage" {
+test "StringManaged Basic Usage" {
     // Create your String
-    var myString = String.init(std.testing.allocator);
+    var myString = StringManaged.init(std.testing.allocator);
     defer myString.deinit();
 
     // Use functions provided
@@ -20,9 +20,9 @@ test "String Basic Usage" {
     try expect(myString.cmp("🔥 Hello, World 🔥"));
 }
 
-test "String Tests" {
+test "StringManaged Tests" {
     // This is how we create the String
-    var myStr = String.init(std.testing.allocator);
+    var myStr = StringManaged.init(std.testing.allocator);
     defer myStr.deinit();
 
     // allocate & capacity
@@ -113,15 +113,15 @@ test "String Tests" {
     try expectEqualStrings(myStr.split("💯", 5).?, "Hello");
     try expectEqualStrings(myStr.split("💯", 6).?, "");
 
-    var splitStr = String.init(std.testing.allocator);
+    var splitStr = StringManaged.init(std.testing.allocator);
     defer splitStr.deinit();
 
     try splitStr.concat("variable='value'");
     try expectEqualStrings(splitStr.split("=", 0).?, "variable");
     try expectEqualStrings(splitStr.split("=", 1).?, "'value'");
 
     // splitAll
-    var splitAllStr = try String.init_with_contents(std.testing.allocator, "THIS IS A  TEST");
+    var splitAllStr = try StringManaged.init_with_contents(std.testing.allocator, "THIS IS A  TEST");
     defer splitAllStr.deinit();
     const splitAllSlices = try splitAllStr.splitAll(" ");
 
@@ -155,7 +155,7 @@ test "String Tests" {
     // lines
     const lineSlice = "Line0\r\nLine1\nLine2";
 
-    var lineStr = try String.init_with_contents(std.testing.allocator, lineSlice);
+    var lineStr = try StringManaged.init_with_contents(std.testing.allocator, lineSlice);
     defer lineStr.deinit();
     var linesSlice = try lineStr.lines();
     defer for (linesSlice) |*str| {
@@ -214,26 +214,26 @@ test "String Tests" {
     // try expectEqual(std.os.windows.kernel32.GetConsoleOutputCP(), 65001);
 }
 
-test "String init with contents" {
+test "StringManaged init with contents" {
     const initial_contents = "String with initial contents!";
 
     // This is how we create the String with contents at the start
-    var myStr = try String.init_with_contents(std.testing.allocator, initial_contents);
+    var myStr = try StringManaged.init_with_contents(std.testing.allocator, initial_contents);
     defer myStr.deinit();
     try expectEqualStrings(myStr.str(), initial_contents);
 }
 
-test "String startsWith Tests" {
-    var myString = String.init(std.testing.allocator);
+test "StringManaged startsWith Tests" {
+    var myString = StringManaged.init(std.testing.allocator);
     defer myString.deinit();
 
     try myString.concat("bananas");
     try expect(myString.startsWith("bana"));
     try expect(!myString.startsWith("abc"));
 }
 
-test "String endsWith Tests" {
-    var myString = String.init(std.testing.allocator);
+test "StringManaged endsWith Tests" {
+    var myString = StringManaged.init(std.testing.allocator);
     defer myString.deinit();
 
     try myString.concat("asbananas");
@@ -246,9 +246,9 @@ test "String endsWith Tests" {
     try expect(myString.endsWith("hello💯"));
 }
 
-test "String replace Tests" {
+test "StringManaged replace Tests" {
     // Create your String
-    var myString = String.init(std.testing.allocator);
+    var myString = StringManaged.init(std.testing.allocator);
     defer myString.deinit();
 
     try myString.concat("hi,how are you");
@@ -265,27 +265,27 @@ test "String replace Tests" {
     try expectEqualStrings(myString.str(), "💯hi💯💯hi💯💯hi💯");
 }
 
-test "String rfind Tests" {
-    var myString = try String.init_with_contents(std.testing.allocator, "💯hi💯💯hi💯💯hi💯");
+test "StringManaged rfind Tests" {
+    var myString = try StringManaged.init_with_contents(std.testing.allocator, "💯hi💯💯hi💯💯hi💯");
     defer myString.deinit();
 
     try expectEqual(myString.rfind("hi"), 9);
 }
 
-test "String toCapitalized Tests" {
-    var myString = try String.init_with_contents(std.testing.allocator, "love and be loved");
+test "StringManaged toCapitalized Tests" {
+    var myString = try StringManaged.init_with_contents(std.testing.allocator, "love and be loved");
     defer myString.deinit();
 
     myString.toCapitalized();
 
     try expectEqualStrings(myString.str(), "Love And Be Loved");
 }
 
-test "String includes Tests" {
-    var myString = try String.init_with_contents(std.testing.allocator, "love and be loved");
+test "StringManaged includes Tests" {
+    var myString = try StringManaged.init_with_contents(std.testing.allocator, "love and be loved");
     defer myString.deinit();
 
-    var needle = try String.init_with_contents(std.testing.allocator, "be");
+    var needle = try StringManaged.init_with_contents(std.testing.allocator, "be");
     defer needle.deinit();
 
     try expect(myString.includesLiteral("and"));

zig-string.zig renamed to stringz.zig

@@ -3,7 +3,7 @@ const assert = std.debug.assert;
 const builtin = @import("builtin");
 
 /// A managed variable length collection of characters
-pub const String = struct {
+pub const StringManaged = struct {
     /// A variable length collection of characters
     const Self = @This();
     /// The internal character buffer