proto: document reset memory aliasing guarantees
Change-Id: I2dc79c362278b6bc9ccf531067701cba5c392a50
Reviewed-on: https://go-review.googlesource.com/c/protobuf/+/219141
Reviewed-by: Damien Neil <dneil@google.com>
diff --git a/proto/reset.go b/proto/reset.go
index b861f5b..11eecfe 100644
--- a/proto/reset.go
+++ b/proto/reset.go
@@ -7,8 +7,9 @@
import "google.golang.org/protobuf/reflect/protoreflect"
// Reset clears every field in the message.
+// The resulting message shares no observable memory with its previous state
+// other than the memory for the message itself.
func Reset(m Message) {
- // TODO(blocks): Document memory aliasing guarantees.
if mr, ok := m.(interface{ Reset() }); ok && hasProtoMethods {
mr.Reset()
return
