github.com/linchen2chris/hugo@v0.0.0-20230307053224-cec209389705/bufferpool/bufpool.go (about)

     1  // Copyright 2015 The Hugo Authors. All rights reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  // http://www.apache.org/licenses/LICENSE-2.0
     7  //
     8  // Unless required by applicable law or agreed to in writing, software
     9  // distributed under the License is distributed on an "AS IS" BASIS,
    10  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  // Package bufferpool provides a pool of bytes buffers.
    15  package bufferpool
    16  
    17  import (
    18  	"bytes"
    19  	"sync"
    20  )
    21  
    22  var bufferPool = &sync.Pool{
    23  	New: func() any {
    24  		return &bytes.Buffer{}
    25  	},
    26  }
    27  
    28  // GetBuffer returns a buffer from the pool.
    29  func GetBuffer() (buf *bytes.Buffer) {
    30  	return bufferPool.Get().(*bytes.Buffer)
    31  }
    32  
    33  // PutBuffer returns a buffer to the pool.
    34  // The buffer is reset before it is put back into circulation.
    35  func PutBuffer(buf *bytes.Buffer) {
    36  	buf.Reset()
    37  	bufferPool.Put(buf)
    38  }