github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/metrics/matcher/cache/elem_new_map_gen.go (about)

     1  // Copyright (c) 2021 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  // This file was automatically generated by genny.
    22  // Any changes will be lost if this file is regenerated.
    23  // see https://github.com/mauricelam/genny
    24  
    25  package cache
    26  
    27  import (
    28  	"bytes"
    29  
    30  	"github.com/m3db/m3/src/x/pool"
    31  
    32  	"github.com/cespare/xxhash/v2"
    33  )
    34  
    35  // Copyright (c) 2018 Uber Technologies, Inc.
    36  //
    37  // Permission is hereby granted, free of charge, to any person obtaining a copy
    38  // of this software and associated documentation files (the "Software"), to deal
    39  // in the Software without restriction, including without limitation the rights
    40  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    41  // copies of the Software, and to permit persons to whom the Software is
    42  // furnished to do so, subject to the following conditions:
    43  //
    44  // The above copyright notice and this permission notice shall be included in
    45  // all copies or substantial portions of the Software.
    46  //
    47  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    48  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    49  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    50  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    51  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    52  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    53  // THE SOFTWARE.
    54  
    55  // elemMapOptions provides options used when created the map.
    56  type elemMapOptions struct {
    57  	InitialSize int
    58  	KeyCopyPool pool.BytesPool
    59  }
    60  
    61  // newElemMap returns a new byte keyed map.
    62  func newElemMap(opts elemMapOptions) *elemMap {
    63  	var (
    64  		copyFn     elemMapCopyFn
    65  		finalizeFn elemMapFinalizeFn
    66  	)
    67  	if pool := opts.KeyCopyPool; pool == nil {
    68  		copyFn = func(k []byte) []byte {
    69  			return append([]byte(nil), k...)
    70  		}
    71  	} else {
    72  		copyFn = func(k []byte) []byte {
    73  			keyLen := len(k)
    74  			pooled := pool.Get(keyLen)[:keyLen]
    75  			copy(pooled, k)
    76  			return pooled
    77  		}
    78  		finalizeFn = func(k []byte) {
    79  			pool.Put(k)
    80  		}
    81  	}
    82  	return _elemMapAlloc(_elemMapOptions{
    83  		hash: func(k []byte) elemMapHash {
    84  			return elemMapHash(xxhash.Sum64(k))
    85  		},
    86  		equals:      bytes.Equal,
    87  		copy:        copyFn,
    88  		finalize:    finalizeFn,
    89  		initialSize: opts.InitialSize,
    90  	})
    91  }