github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/x/xpool/types.go (about)

     1  // Copyright (c) 2018 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 xpool
    22  
    23  import (
    24  	"github.com/m3db/m3/src/x/checked"
    25  )
    26  
    27  // CheckedBytesWrapperPool allows users to wrap []byte which have been
    28  // allocated by other libraries (e.g. thrift/t-channel) with a checked.Bytes
    29  // abstraction. This is to ensure we reference count usage, and more importantly,
    30  // can interop with the rest of the M3DB codebase (which requires checked.Bytes).
    31  // NB: This pool doesn't require a Put method, as Finalizing the bytes returned from
    32  // Get does the Put internally.
    33  type CheckedBytesWrapperPool interface {
    34  	Init()
    35  
    36  	Get([]byte) checked.Bytes
    37  }