blob: 846323360ee64903284760936cf1951788c92755 [file] [log] [blame]
Scott Baker2c1c4822019-10-16 11:02:41 -07001// Copyright (c) 2016 Uber Technologies, Inc.
2//
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:
9//
10// The above copyright notice and this permission notice shall be included in
11// all copies or substantial portions of the Software.
12//
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
19// THE SOFTWARE.
20
21package buffer
22
Abhay Kumar40252eb2025-10-13 13:25:53 +000023import (
24 "go.uber.org/zap/internal/pool"
25)
Scott Baker2c1c4822019-10-16 11:02:41 -070026
27// A Pool is a type-safe wrapper around a sync.Pool.
28type Pool struct {
Abhay Kumar40252eb2025-10-13 13:25:53 +000029 p *pool.Pool[*Buffer]
Scott Baker2c1c4822019-10-16 11:02:41 -070030}
31
32// NewPool constructs a new Pool.
33func NewPool() Pool {
Abhay Kumar40252eb2025-10-13 13:25:53 +000034 return Pool{
35 p: pool.New(func() *Buffer {
36 return &Buffer{
37 bs: make([]byte, 0, _size),
38 }
39 }),
40 }
Scott Baker2c1c4822019-10-16 11:02:41 -070041}
42
43// Get retrieves a Buffer from the pool, creating one if necessary.
44func (p Pool) Get() *Buffer {
Abhay Kumar40252eb2025-10-13 13:25:53 +000045 buf := p.p.Get()
Scott Baker2c1c4822019-10-16 11:02:41 -070046 buf.Reset()
47 buf.pool = p
48 return buf
49}
50
51func (p Pool) put(buf *Buffer) {
52 p.p.Put(buf)
53}