1 // Copyright (c) 2016 Uber Technologies, Inc.
3 // Permission is hereby granted, free of charge, to any person obtaining a copy
4 // of this software and associated documentation files (the "Software"), to deal
5 // in the Software without restriction, including without limitation the rights
6 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 // copies of the Software, and to permit persons to whom the Software is
8 // furnished to do so, subject to the following conditions:
10 // The above copyright notice and this permission notice shall be included in
11 // all copies or substantial portions of the Software.
13 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 // Package buffer provides a thin wrapper around a byte slice. Unlike the
22 // standard library's bytes.Buffer, it supports a portion of the strconv
23 // package's zero-allocation formatters.
24 package buffer // import "go.uber.org/zap/buffer"
28 const _size = 1024 // by default, create 1 KiB buffers
30 // Buffer is a thin wrapper around a byte slice. It's intended to be pooled, so
31 // the only way to construct one is via a Pool.
37 // AppendByte writes a single byte to the Buffer.
38 func (b *Buffer) AppendByte(v byte) {
39 b.bs = append(b.bs, v)
42 // AppendString writes a string to the Buffer.
43 func (b *Buffer) AppendString(s string) {
44 b.bs = append(b.bs, s...)
47 // AppendInt appends an integer to the underlying buffer (assuming base 10).
48 func (b *Buffer) AppendInt(i int64) {
49 b.bs = strconv.AppendInt(b.bs, i, 10)
52 // AppendUint appends an unsigned integer to the underlying buffer (assuming
54 func (b *Buffer) AppendUint(i uint64) {
55 b.bs = strconv.AppendUint(b.bs, i, 10)
58 // AppendBool appends a bool to the underlying buffer.
59 func (b *Buffer) AppendBool(v bool) {
60 b.bs = strconv.AppendBool(b.bs, v)
63 // AppendFloat appends a float to the underlying buffer. It doesn't quote NaN
65 func (b *Buffer) AppendFloat(f float64, bitSize int) {
66 b.bs = strconv.AppendFloat(b.bs, f, 'f', -1, bitSize)
69 // Len returns the length of the underlying byte slice.
70 func (b *Buffer) Len() int {
74 // Cap returns the capacity of the underlying byte slice.
75 func (b *Buffer) Cap() int {
79 // Bytes returns a mutable reference to the underlying byte slice.
80 func (b *Buffer) Bytes() []byte {
84 // String returns a string copy of the underlying byte slice.
85 func (b *Buffer) String() string {
89 // Reset resets the underlying byte slice. Subsequent writes re-use the slice's
91 func (b *Buffer) Reset() {
95 // Write implements io.Writer.
96 func (b *Buffer) Write(bs []byte) (int, error) {
97 b.bs = append(b.bs, bs...)
101 // TrimNewline trims any final "\n" byte from the end of the buffer.
102 func (b *Buffer) TrimNewline() {
103 if i := len(b.bs) - 1; i >= 0 {
110 // Free returns the Buffer to its Pool.
112 // Callers must not retain references to the Buffer after calling Free.
113 func (b *Buffer) Free() {