1 // Copyright (c) 2023 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 pool provides internal pool utilities.
22 package pool
23 24 import (
25 "sync"
26 )
27 28 // A Pool is a generic wrapper around [sync.Pool] to provide strongly-typed
29 // object pooling.
30 //
31 // Note that SA6002 (ref: https://staticcheck.io/docs/checks/#SA6002) will
32 // not be detected, so all internal pool use must take care to only store
33 // pointer types.
34 type Pool[T any] struct {
35 pool sync.Pool
36 }
37 38 // New returns a new [Pool] for T, and will use fn to construct new Ts when
39 // the pool is empty.
40 func New[T any](fn func() T) *Pool[T] {
41 return &Pool[T]{
42 pool: sync.Pool{
43 New: func() any {
44 return fn()
45 },
46 },
47 }
48 }
49 50 // Get gets a T from the pool, or creates a new one if the pool is empty.
51 func (p *Pool[T]) Get() T {
52 return p.pool.Get().(T)
53 }
54 55 // Put returns x into the pool.
56 func (p *Pool[T]) Put(x T) {
57 p.pool.Put(x)
58 }
59