From 1acb3162b7e24e6badad4aff37dbeac09f47f165 Mon Sep 17 00:00:00 2001
From: Ryan Liptak <squeek502@hotmail.com>
Date: Sun, 23 Apr 2023 15:32:11 -0700
Subject: [PATCH] http.Headers: Add `clearAndFree` and `clearRetainingCapacity`

---
 lib/std/http/Headers.zig | 84 ++++++++++++++++++++++++++++++++++------
 1 file changed, 73 insertions(+), 11 deletions(-)

diff --git a/lib/std/http/Headers.zig b/lib/std/http/Headers.zig
index e84a890862070786a80cbd2ba41ca2b50d133b42..0322c32481a2e6278bc847296ae560b873d1098d 100644
--- a/lib/std/http/Headers.zig
+++ b/lib/std/http/Headers.zig
@@ -68,17 +68,7 @@ pub const Headers = struct {
     }
 
     pub fn deinit(headers: *Headers) void {
-        var it = headers.index.iterator();
-        while (it.next()) |entry| {
-            entry.value_ptr.deinit(headers.allocator);
-
-            if (headers.owned) headers.allocator.free(entry.key_ptr.*);
-        }
-
-        for (headers.list.items) |entry| {
-            if (headers.owned) headers.allocator.free(entry.value);
-        }
-
+        headers.deallocateIndexListsAndFields();
         headers.index.deinit(headers.allocator);
         headers.list.deinit(headers.allocator);
 
@@ -255,6 +245,39 @@ pub const Headers = struct {
 
         try out_stream.writeAll("\r\n");
     }
+
+    /// Frees all `HeaderIndexList`s within `index`
+    /// Frees names and values of all fields if they are owned.
+    fn deallocateIndexListsAndFields(headers: *Headers) void {
+        var it = headers.index.iterator();
+        while (it.next()) |entry| {
+            entry.value_ptr.deinit(headers.allocator);
+
+            if (headers.owned) headers.allocator.free(entry.key_ptr.*);
+        }
+
+        if (headers.owned) {
+            for (headers.list.items) |entry| {
+                headers.allocator.free(entry.value);
+            }
+        }
+    }
+
+    /// Clears and frees the underlying data structures.
+    /// Frees names and values if they are owned.
+    pub fn clearAndFree(headers: *Headers) void {
+        headers.deallocateIndexListsAndFields();
+        headers.index.clearAndFree(headers.allocator);
+        headers.list.clearAndFree(headers.allocator);
+    }
+
+    /// Clears the underlying data structures while retaining their capacities.
+    /// Frees names and values if they are owned.
+    pub fn clearRetainingCapacity(headers: *Headers) void {
+        headers.deallocateIndexListsAndFields();
+        headers.index.clearRetainingCapacity();
+        headers.list.clearRetainingCapacity();
+    }
 };
 
 test "Headers.append" {
@@ -384,3 +407,42 @@ test "Headers consistency" {
     try h.formatCommaSeparated("foo", writer);
     try testing.expectEqualStrings("foo: bar, baz\r\n", fbs.getWritten());
 }
+
+test "Headers.clearRetainingCapacity and clearAndFree" {
+    var h = Headers.init(std.testing.allocator);
+    defer h.deinit();
+
+    h.clearRetainingCapacity();
+
+    try h.append("foo", "bar");
+    try h.append("bar", "world");
+    try h.append("foo", "baz");
+    try h.append("baz", "hello");
+    try testing.expectEqual(@as(usize, 4), h.list.items.len);
+    try testing.expectEqual(@as(usize, 3), h.index.count());
+    const list_capacity = h.list.capacity;
+    const index_capacity = h.index.capacity();
+
+    h.clearRetainingCapacity();
+    try testing.expectEqual(@as(usize, 0), h.list.items.len);
+    try testing.expectEqual(@as(usize, 0), h.index.count());
+    try testing.expectEqual(list_capacity, h.list.capacity);
+    try testing.expectEqual(index_capacity, h.index.capacity());
+
+    try h.append("foo", "bar");
+    try h.append("bar", "world");
+    try h.append("foo", "baz");
+    try h.append("baz", "hello");
+    try testing.expectEqual(@as(usize, 4), h.list.items.len);
+    try testing.expectEqual(@as(usize, 3), h.index.count());
+    // Capacity should still be the same since we shouldn't have needed to grow
+    // when adding back the same fields
+    try testing.expectEqual(list_capacity, h.list.capacity);
+    try testing.expectEqual(index_capacity, h.index.capacity());
+
+    h.clearAndFree();
+    try testing.expectEqual(@as(usize, 0), h.list.items.len);
+    try testing.expectEqual(@as(usize, 0), h.index.count());
+    try testing.expectEqual(@as(usize, 0), h.list.capacity);
+    try testing.expectEqual(@as(usize, 0), h.index.capacity());
+}
-- 
2.54.0