package buffer

Import Path
	github.com/mailru/easyjson/buffer (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	  d pool.go
		Package buffer implements a buffer for serialization, consisting of a chain of []byte-s to
		reduce copying and to allow reuse of individual chunks.
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type Buffer (struct)
		Buffer is a buffer optimized for serialization without extra copying.

		Fields (only one)
			Buf []byte
				Buf is the current chunk that can be used for serialization.

		Methods (total 8)
			(*Buffer) AppendByte(data byte)
				AppendByte appends a single byte to buffer.

			(*Buffer) AppendBytes(data []byte)
				AppendBytes appends a byte slice to buffer.

			(*Buffer) AppendString(data string)
				AppendString appends a string to buffer.

			(*Buffer) BuildBytes(reuse ...[]byte) []byte
				BuildBytes creates a single byte slice with all the contents of the buffer. Data is
				copied if it does not fit in a single chunk. You can optionally provide one byte
				slice as argument that it will try to reuse.

			(*Buffer) DumpTo(w io.Writer) (written int, err error)
				DumpTo outputs the contents of a buffer to a writer and resets the buffer.

			(*Buffer) EnsureSpace(s int)
				EnsureSpace makes sure that the current chunk contains at least s free bytes,
				possibly creating a new chunk.

			(*Buffer) ReadCloser() io.ReadCloser
				ReadCloser creates an io.ReadCloser with all the contents of the buffer.

			(*Buffer) Size() int
				Size computes the size of a buffer by adding sizes of every chunk.

		Implements (at least one exported)
			*Buffer : github.com/gogo/protobuf/proto.Sizer

	 type PoolConfig (struct)
		PoolConfig contains configuration for the allocation and reuse strategy.

		Fields (total 3)
			MaxSize int
				// Maximum chunk size that will be allocated.

			PooledSize int
				// Minimum chunk size that is reused, reusing chunks too small will result in overhead.

			StartSize int
				// Minimum chunk size that is allocated.

		As Inputs Of (at least one exported)
			func Init(cfg PoolConfig)


Package-Level Functions (only one)

	 func Init(cfg PoolConfig)
		Init sets up a non-default pooling and allocation strategy. Should be run before serialization is done.

The pages are generated with Golds v0.8.2. (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 @zigo_101 (reachable from the left QR code) to get the latest news of Golds.