package bytebufferpool

Import Path
	github.com/valyala/bytebufferpool (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 4 packages

Involved Source Files

	    bytebuffer.go
	  d doc.go
		Package bytebufferpool implements a pool of byte buffers
		with anti-fragmentation protection.
		
		The pool may waste limited amount of memory due to fragmentation.
		This amount equals to the maximum total size of the byte buffers
		in concurrent use.

	    pool.go
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type ByteBuffer (struct)
		ByteBuffer provides byte buffer, which can be used for minimizing
		memory allocations.
		
		ByteBuffer may be used with functions appending data to the given []byte
		slice. See example code for details.
		
		Use Get for obtaining an empty byte buffer.

		Fields (only one)
			B []byte
				B is a byte buffer to use in append-like workloads.
				See example code for details.

		Methods (total 11)
			(*ByteBuffer) Bytes() []byte
				Bytes returns b.B, i.e. all the bytes accumulated in the buffer.
				
				The purpose of this function is bytes.Buffer compatibility.

			(*ByteBuffer) Len() int
				Len returns the size of the byte buffer.

			(*ByteBuffer) ReadFrom(r io.Reader) (int64, error)
				ReadFrom implements io.ReaderFrom.
				
				The function appends all the data read from r to b.

			(*ByteBuffer) Reset()
				Reset makes ByteBuffer.B empty.

			(*ByteBuffer) Set(p []byte)
				Set sets ByteBuffer.B to p.

			(*ByteBuffer) SetString(s string)
				SetString sets ByteBuffer.B to s.

			(*ByteBuffer) String() string
				String returns string representation of ByteBuffer.B.

			(*ByteBuffer) Write(p []byte) (int, error)
				Write implements io.Writer - it appends p to ByteBuffer.B

			(*ByteBuffer) WriteByte(c byte) error
				WriteByte appends the byte c to the buffer.
				
				The purpose of this function is bytes.Buffer compatibility.
				
				The function always returns nil.

			(*ByteBuffer) WriteString(s string) (int, error)
				WriteString appends s to ByteBuffer.B.

			(*ByteBuffer) WriteTo(w io.Writer) (int64, error)
				WriteTo implements io.WriterTo.

		Implements (at least 9)
			*ByteBuffer : github.com/ChrisTrenkamp/goxpath/tree.Result
			*ByteBuffer : fmt.Stringer
			*ByteBuffer : gorm.io/gorm/clause.Writer
			*ByteBuffer : internal/bisect.Writer
			*ByteBuffer : io.ByteWriter
			*ByteBuffer : io.ReaderFrom
			*ByteBuffer : io.StringWriter
			*ByteBuffer : io.Writer
			*ByteBuffer : io.WriterTo
		As Outputs Of (at least 2)
			func Get() *ByteBuffer
			func (*Pool).Get() *ByteBuffer
		As Inputs Of (at least 2)
			func Put(b *ByteBuffer)
			func (*Pool).Put(b *ByteBuffer)

	 type Pool (struct)
		Pool represents byte buffer pool.
		
		Distinct pools may be used for distinct types of byte buffers.
		Properly determined byte buffer types with their own pools may help reducing
		memory waste.

		Methods (total 2)
			(*Pool) Get() *ByteBuffer
				Get returns new byte buffer with zero length.
				
				The byte buffer may be returned to the pool via Put after the use
				in order to minimize GC overhead.

			(*Pool) Put(b *ByteBuffer)
				Put releases byte buffer obtained via Get to the pool.
				
				The buffer mustn't be accessed after returning to the pool.



Package-Level Functions (total 2)

	 func Get() *ByteBuffer
		Get returns an empty byte buffer from the pool.
		
		Got byte buffer may be returned to the pool via Put call.
		This reduces the number of memory allocations required for byte buffer
		management.

	 func Put(b *ByteBuffer)
		Put returns byte buffer to the pool.
		
		ByteBuffer.B mustn't be touched after returning it to the pool.
		Otherwise data races will occur.

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.