package buffer

Import Path
	go.uber.org/zap/buffer (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 3 packages

Involved Source Files

	  d buffer.go
		Package buffer provides a thin wrapper around a byte slice. Unlike the
		standard library's bytes.Buffer, it supports a portion of the strconv
		package's zero-allocation formatters.

	    pool.go
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Buffer (struct)
		Buffer is a thin wrapper around a byte slice. It's intended to be pooled, so
		the only way to construct one is via a Pool.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			bs []byte
			pool Pool
		Methods (total 18, all are exported)
			(*Buffer) AppendBool(v bool)
				AppendBool appends a bool to the underlying buffer.

			(*Buffer) AppendByte(v byte)
				AppendByte writes a single byte to the Buffer.

			(*Buffer) AppendBytes(v []byte)
				AppendBytes writes a single byte to the Buffer.

			(*Buffer) AppendFloat(f float64, bitSize int)
				AppendFloat appends a float to the underlying buffer. It doesn't quote NaN
				or +/- Inf.

			(*Buffer) AppendInt(i int64)
				AppendInt appends an integer to the underlying buffer (assuming base 10).

			(*Buffer) AppendString(s string)
				AppendString writes a string to the Buffer.

			(*Buffer) AppendTime(t time.Time, layout string)
				AppendTime appends the time formatted using the specified layout.

			(*Buffer) AppendUint(i uint64)
				AppendUint appends an unsigned integer to the underlying buffer (assuming
				base 10).

			(*Buffer) Bytes() []byte
				Bytes returns a mutable reference to the underlying byte slice.

			(*Buffer) Cap() int
				Cap returns the capacity of the underlying byte slice.

			(*Buffer) Free()
				Free returns the Buffer to its Pool.
				
				Callers must not retain references to the Buffer after calling Free.

			(*Buffer) Len() int
				Len returns the length of the underlying byte slice.

			(*Buffer) Reset()
				Reset resets the underlying byte slice. Subsequent writes re-use the slice's
				backing array.

			(*Buffer) String() string
				String returns a string copy of the underlying byte slice.

			(*Buffer) TrimNewline()
				TrimNewline trims any final "\n" byte from the end of the buffer.

			(*Buffer) Write(bs []byte) (int, error)
				Write implements io.Writer.

			(*Buffer) WriteByte(v byte) error
				WriteByte writes a single byte to the Buffer.
				
				Error returned is always nil, function signature is compatible
				with bytes.Buffer and bufio.Writer

			(*Buffer) WriteString(s string) (int, error)
				WriteString writes a string to the Buffer.
				
				Error returned is always nil, function signature is compatible
				with bytes.Buffer and bufio.Writer

		Implements (at least 9, in which 5 are exported)
			*Buffer : fmt.Stringer
			*Buffer : internal/bisect.Writer
			*Buffer : io.ByteWriter
			*Buffer : io.StringWriter
			*Buffer : io.Writer
			/* 4+ unexporteds ... *//* 4+ unexporteds: */
			*Buffer : context.stringer
			*Buffer : crypto/tls.transcriptHash
			*Buffer : net/http.http2stringWriter
			*Buffer : runtime.stringer
		As Outputs Of (at least 2, both are exported)
			func Pool.Get() *Buffer
			func go.uber.org/zap/zapcore.Encoder.EncodeEntry(zapcore.Entry, []zapcore.Field) (*Buffer, error)
		As Inputs Of (at least 3, in which 1 is exported)
			func go.uber.org/zap/internal/stacktrace.NewFormatter(b *Buffer) stacktrace.Formatter
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func Pool.put(buf *Buffer)
			func go.uber.org/zap/zapcore.safeAppendStringLike[S](appendTo func(*Buffer, S), decodeRune func(S) (rune, int), buf *Buffer, s S)

	 type Pool (struct)
		A Pool is a type-safe wrapper around a sync.Pool.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			p *pool.Pool[*Buffer]
		Methods (total 2, in which 1 is exported)
			( Pool) Get() *Buffer
				Get retrieves a Buffer from the pool, creating one if necessary.

			/* one unexported ... *//* one unexported: */
			( Pool) put(buf *Buffer)
		As Outputs Of (at least one exported)
			func NewPool() Pool
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var go.uber.org/zap/internal/bufferpool._pool


Package-Level Functions (only one, which is exported)

	 func NewPool() Pool
		NewPool constructs a new Pool.


Package-Level Constants (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	const _size = 1024 // by default, create 1 KiB buffers

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.