github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/ident/identifier.go (about)

     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 ident
    22  
    23  import (
    24  	"bytes"
    25  
    26  	"github.com/m3db/m3/src/x/checked"
    27  )
    28  
    29  // BinaryID constructs a new ID based on a binary value.
    30  func BinaryID(v checked.Bytes) ID {
    31  	v.IncRef()
    32  	return &id{data: v}
    33  }
    34  
    35  // StringID constructs a new ID based on a string value.
    36  func StringID(str string) ID {
    37  	return BytesID(str)
    38  }
    39  
    40  type id struct {
    41  	data       checked.Bytes
    42  	pool       Pool
    43  	noFinalize bool
    44  }
    45  
    46  // Bytes directly returns the underlying bytes of an ID, it is not safe
    47  // to hold a reference to this slice and is only valid during the lifetime
    48  // of the the ID itself.
    49  func (v *id) Bytes() []byte {
    50  	if v.data == nil {
    51  		return nil
    52  	}
    53  	return v.data.Bytes()
    54  }
    55  
    56  func (v *id) Equal(value ID) bool {
    57  	return bytes.Equal(v.Bytes(), value.Bytes())
    58  }
    59  
    60  func (v *id) NoFinalize() {
    61  	v.noFinalize = true
    62  }
    63  
    64  func (v *id) IsNoFinalize() bool {
    65  	return v.noFinalize
    66  }
    67  
    68  func (v *id) Finalize() {
    69  	if v.noFinalize {
    70  		return
    71  	}
    72  	v.data.DecRef()
    73  	v.data.Finalize()
    74  	v.data = nil
    75  
    76  	if v.pool == nil {
    77  		return
    78  	}
    79  
    80  	v.pool.Put(v)
    81  }
    82  
    83  func (v *id) String() string {
    84  	return string(v.Bytes())
    85  }