From 72069debdc235ee39bdc8a4806653bf82bc08fe1 Mon Sep 17 00:00:00 2001 From: Felix Lange Date: Mon, 7 Feb 2022 15:00:51 +0100 Subject: [PATCH] rlp: document that zero value of EncoderBuffer is not valid --- rlp/encbuffer.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/rlp/encbuffer.go b/rlp/encbuffer.go index 145c2e658b130..0e200a9a33bbe 100644 --- a/rlp/encbuffer.go +++ b/rlp/encbuffer.go @@ -249,6 +249,9 @@ func (r *encReader) next() []byte { } // EncoderBuffer is a buffer for incremental encoding. +// +// The zero value is NOT ready for use. To get a usable buffer, +// create it using NewEncoderBuffer or call Reset. type EncoderBuffer struct { buf *encBuffer dst io.Writer