github.com/m3db/m3@v1.5.0/src/m3ninx/index/segment/mem/postings_map_new.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 mem
    22  
    23  import (
    24  	"bytes"
    25  
    26  	"github.com/cespare/xxhash/v2"
    27  )
    28  
    29  // newPostingsMap returns a new []bytes->postings.MutableList map.
    30  func newPostingsMap(initialSize int) *postingsMap {
    31  	return _postingsMapAlloc(_postingsMapOptions{
    32  		hash: func(k []byte) postingsMapHash {
    33  			return postingsMapHash(xxhash.Sum64(k))
    34  		},
    35  		equals:      bytes.Equal,
    36  		copy:        undefinedPostingsMapCopyFn,
    37  		finalize:    undefinedFinalizeFn,
    38  		initialSize: initialSize,
    39  	})
    40  }
    41  
    42  var undefinedPostingsMapCopyFn postingsMapCopyFn = func([]byte) []byte {
    43  	// NB: intentionally not defined to force users of the map to not
    44  	// allocate extra copies.
    45  	panic("not implemented")
    46  }
    47  
    48  var undefinedFinalizeFn postingsMapFinalizeFn = func([]byte) {
    49  	// NB: intentionally not defined to force users of the map to not
    50  	// allocate extra copies.
    51  	panic("not implemented")
    52  }