Exported ByteBuffer

bytebuffer.go

@@ -0,0 +1,46 @@
+package fasthttp
+
+import (
+	"sync"
+)
+
+const (
+	defaultByteBufferSize = 128
+)
+
+// ByteBuffer provides byte buffer, which can be used with fasthttp API
+// in order to minimize memory allocations.
+//
+// ByteBuffer may be used with functions appending data to the given []byte
+// slice. See example code for details.
+//
+// Use AcquireByteBuffer for obtaining an empty byte buffer.
+type ByteBuffer struct {
+	B []byte
+}
+
+// AcquireByteBuffer returns an empty byte buffer from the pool.
+//
+// Acquired byte buffer may be returned to the pool via ReleaseByteBuffer call.
+// This reduces the number of memory allocations required for byte buffer
+// management.
+func AcquireByteBuffer() *ByteBuffer {
+	v := byteBufferPool.Get()
+	if v == nil {
+		return &ByteBuffer{
+			B: make([]byte, 0, defaultByteBufferSize),
+		}
+	}
+	return v.(*ByteBuffer)
+}
+
+// ReleaseByteBuffer returns byte buffer to the pool.
+//
+// ByteBuffer.B mustn't be touched after returning it to the pool.
+// Otherwise data races occur.
+func ReleaseByteBuffer(b *ByteBuffer) {
+	b.B = b.B[:0]
+	byteBufferPool.Put(b)
+}
+
+var byteBufferPool sync.Pool