doc: add doc for generic interface

rvagg · rvagg · commit 48b9a986bbcf · 2024-08-05T20:51:28.000+10:00
diff --git a/hamt.go b/hamt.go
@@ -32,6 +32,9 @@ const (
 	UNMODIFIED = modified(false)
 )
 
+// HamtValue is an interface that must be implemented by the values stored in
+// the HAMT. It is used to create new instances of the value type, to
+// compare values for equality and to handle serialization.
 type HamtValue[V any] interface {
 	New() V
 	Equals(V) bool

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,9 @@ const (`
`32`	`32`	`UNMODIFIED = modified(false)`
`33`	`33`	`)`
`34`	`34`
	`35`	`+// HamtValue is an interface that must be implemented by the values stored in`
	`36`	`+// the HAMT. It is used to create new instances of the value type, to`
	`37`	`+// compare values for equality and to handle serialization.`
`35`	`38`	`type HamtValue[V any] interface {`
`36`	`39`	`New() V`
`37`	`40`	`Equals(V) bool`