pool.go raw

   1  // 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  
  21  package buffer
  22  
  23  import (
  24  	"go.uber.org/zap/internal/pool"
  25  )
  26  
  27  // A Pool is a type-safe wrapper around a sync.Pool.
  28  type Pool struct {
  29  	p *pool.Pool[*Buffer]
  30  }
  31  
  32  // NewPool constructs a new Pool.
  33  func NewPool() Pool {
  34  	return Pool{
  35  		p: pool.New(func() *Buffer {
  36  			return &Buffer{
  37  				bs: make([]byte, 0, _size),
  38  			}
  39  		}),
  40  	}
  41  }
  42  
  43  // Get retrieves a Buffer from the pool, creating one if necessary.
  44  func (p Pool) Get() *Buffer {
  45  	buf := p.p.Get()
  46  	buf.Reset()
  47  	buf.pool = p
  48  	return buf
  49  }
  50  
  51  func (p Pool) put(buf *Buffer) {
  52  	p.p.Put(buf)
  53  }
  54