Do not export Attrs.Encode() method.

Author: jbub

CHANGELOG.md

@@ -1,3 +1,8 @@
+## v0.1.0
+
+- Pass `context.Context` to `Comment` method.
+- Do not export `Attrs.Encode()` method.
+
 ## v0.0.1
 
 - Initial release.

README.md

@@ -5,6 +5,8 @@
 
 Go implementation of https://google.github.io/sqlcommenter/.
 
+Public API is not stable, expect breaking changes.
+
 ## Usage with pgx stdlib driver
 
 ```go

attrs.go

@@ -24,7 +24,13 @@ type Attr struct {
 
 type Attrs map[string]string
 
-func (a Attrs) Encode() string {
+func (a Attrs) Update(other Attrs) {
+	for k, v := range other {
+		a[k] = v
+	}
+}
+
+func (a Attrs) encode() string {
 	total := len(a)
 	keys := make([]string, 0, total)
 	for k := range a {
@@ -44,12 +50,6 @@ func (a Attrs) Encode() string {
 	return b.String()
 }
 
-func (a Attrs) Update(other Attrs) {
-	for k, v := range other {
-		a[k] = v
-	}
-}
-
 func encodeKey(k string) string {
 	return url.QueryEscape(k)
 }

attrs_test.go

@@ -33,10 +33,25 @@ func TestAttrsEncode(t *testing.T) {
 
 	for _, cs := range cases {
 		t.Run(cs.name, func(t *testing.T) {
-			got := cs.attrs.Encode()
+			got := cs.attrs.encode()
 			if want := cs.want; want != got {
 				t.Errorf("got '%v', want '%v'", got, want)
 			}
 		})
 	}
 }
+
+func BenchmarkAttrsEncode(b *testing.B) {
+	b.ReportAllocs()
+	b.SetBytes(2)
+
+	attrs := Attrs(map[string]string{
+		"key":  "value",
+		"2key": "value 33",
+		"key3": "44  value",
+	})
+
+	for i := 0; i < b.N; i++ {
+		attrs.encode()
+	}
+}