github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/m3ninx/postings/atomic.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 postings
    22  
    23  import (
    24  	"go.uber.org/atomic"
    25  )
    26  
    27  // AtomicID is an atomic ID.
    28  type AtomicID struct {
    29  	internal *atomic.Uint32
    30  }
    31  
    32  // NewAtomicID creates a new AtomicID.
    33  func NewAtomicID(id ID) AtomicID {
    34  	return AtomicID{internal: atomic.NewUint32(uint32(id))}
    35  }
    36  
    37  // Load atomically loads the ID.
    38  func (id AtomicID) Load() ID {
    39  	return ID(id.internal.Load())
    40  }
    41  
    42  // Inc atomically increments the ID and returns the new value.
    43  func (id AtomicID) Inc() ID {
    44  	return ID(id.internal.Inc())
    45  }
    46  
    47  // Add atomically adds n to the ID and returns the new ID.
    48  func (id AtomicID) Add(n uint32) ID {
    49  	return ID(id.internal.Add(n))
    50  }