🧹 chore: Add iterator helpers for client types (#3560)

* feat: add All iterators for client cookie and path params

* Remove deprecated VisitAll helpers

Author: ReneWerner87

client/hooks.go

@@ -71,12 +71,12 @@ func parserRequestURL(c *Client, req *Request) error {
 	}
 
 	// Set path parameters from the request and client.
-	req.path.VisitAll(func(key, val string) {
+	for key, val := range req.path.All() {
 		uri = strings.ReplaceAll(uri, ":"+key, val)
-	})
-	c.path.VisitAll(func(key, val string) {
+	}
+	for key, val := range c.path.All() {
 		uri = strings.ReplaceAll(uri, ":"+key, val)
-	})
+	}
 
 	// Set the URI in the raw request.
 	req.RawRequest.SetRequestURI(uri)
@@ -161,14 +161,14 @@ func parserRequestHeader(c *Client, req *Request) error {
 	}
 
 	// Set cookies from the client.
-	c.cookies.VisitAll(func(key, val string) {
+	for key, val := range c.cookies.All() {
 		req.RawRequest.Header.SetCookie(key, val)
-	})
+	}
 
 	// Set cookies from the request.
-	req.cookies.VisitAll(func(key, val string) {
+	for key, val := range req.cookies.All() {
 		req.RawRequest.Header.SetCookie(key, val)
-	})
+	}
 
 	return nil
 }

client/request.go

@@ -765,10 +765,16 @@ func (c Cookie) DelCookies(key ...string) {
 	}
 }
 
-// VisitAll iterates through all cookies, calling f for each.
-func (c Cookie) VisitAll(f func(key, val string)) {
-	for k, v := range c {
-		f(k, v)
+// All returns an iterator over cookie key-value pairs.
+//
+// The returned key and value should not be retained after the iteration loop.
+func (c Cookie) All() iter.Seq2[string, string] {
+	return func(yield func(string, string) bool) {
+		for k, v := range c {
+			if !yield(k, v) {
+				break
+			}
+		}
 	}
 }
 
@@ -815,10 +821,16 @@ func (p PathParam) DelParams(key ...string) {
 	}
 }
 
-// VisitAll iterates through all path parameters, calling f for each.
-func (p PathParam) VisitAll(f func(key, val string)) {
-	for k, v := range p {
-		f(k, v)
+// All returns an iterator over path parameter key-value pairs.
+//
+// The returned key and value should not be retained after the iteration loop.
+func (p PathParam) All() iter.Seq2[string, string] {
+	return func(yield func(string, string) bool) {
+		for k, v := range p {
+			if !yield(k, v) {
+				break
+			}
+		}
 	}
 }
 

docs/client/hooks.md

@@ -159,9 +159,9 @@ func main() {
         fmt.Printf("HTTP protocol: %s\n\n", resp.Protocol())
 
         fmt.Println("Response Headers:")
-        resp.RawResponse.Header.VisitAll(func(key, value []byte) {
-            fmt.Printf("%s: %s\n", key, value)
-        })
+       for key, value := range resp.RawResponse.Header.All() {
+           fmt.Printf("%s: %s\n", key, value)
+       }
 
         return nil
     })

docs/client/request.md

@@ -1205,12 +1205,13 @@ func (c Cookie) SetCookiesWithStruct(v any)
 func (c Cookie) DelCookies(key ...string)
 ```
 
-### VisitAll
+### All
 
-**VisitAll** iterates over all cookies and executes a given function.
+**All** returns an iterator over all cookies. The key and value returned
+should not be retained after the loop ends.
 
 ```go title="Signature"
-func (c Cookie) VisitAll(f func(key, val string))
+func (c Cookie) All() iter.Seq2[string, string]
 ```
 
 ### Reset
@@ -1277,12 +1278,13 @@ func (p PathParam) SetParamsWithStruct(v any)
 func (p PathParam) DelParams(key ...string)
 ```
 
-### VisitAll
+### All
 
-**VisitAll** iterates over all path parameters and executes the provided function.
+**All** returns an iterator over all path parameters. The key and value returned
+should not be retained after the loop ends.
 
 ```go title="Signature"
-func (p PathParam) VisitAll(f func(key, val string))
+func (p PathParam) All() iter.Seq2[string, string]
 ```
 
 ### Reset