core/types: add comment about buffer reuse

This commit is contained in:
Felix Lange 2023-08-23 14:50:01 +02:00
parent 6d445f41f3
commit 8e72579e7c

View file

@ -38,10 +38,11 @@ var encodeBufferPool = sync.Pool{
New: func() interface{} { return new(bytes.Buffer) }, New: func() interface{} { return new(bytes.Buffer) },
} }
// getPooledBuffer retrieves a buffer from the pool and creates a byte slice // getPooledBuffer retrieves a buffer from the pool and creates a byte slice of the
// of the requested size from it. // requested size from it.
// //
// The caller should return the Buffer object back into encodeBufferPool after use! // The caller should return the *bytes.Buffer object back into encodeBufferPool after use!
// The returned byte slice must not be used after returning the buffer.
func getPooledBuffer(size uint64) ([]byte, *bytes.Buffer, error) { func getPooledBuffer(size uint64) ([]byte, *bytes.Buffer, error) {
if size > math.MaxInt { if size > math.MaxInt {
return nil, nil, fmt.Errorf("can't get buffer of size %d", size) return nil, nil, fmt.Errorf("can't get buffer of size %d", size)