NewBuilderFromDocuments returns a builder from documents, it is not thread safe and is optimized for insertion speed and a final build step when documents are indexed.

NewBuilderFromSegments returns a new builder from segments.

NewIDsMap returns a new byte keyed map.

NewOptions returns new options.

NewPostingsMap returns a new byte keyed map.

SetSortConcurrency sets the sort concurrency for when building segments, unfortunately this must be set globally since github.com/twotwotwo/sorts does not provide an ability to set parallelism on call to sort.

IDsMap uses the genny package to provide a generic hash map that can be specialized by running the following command from this root of the repository: ``` make hashmap-gen pkg=outpkg key_type=Type value_type=Type out_dir=/tmp ``` Or if you would like to use bytes or ident.ID as keys you can use the partially specialized maps to generate your own maps as well: ``` make byteshashmap-gen pkg=outpkg value_type=Type out_dir=/tmp make idhashmap-gen pkg=outpkg value_type=Type out_dir=/tmp ``` This will output to stdout the generated source file to use for your map.

IDsMapEntry is an entry in the map, this is public to support iterating over the map using a native Go for loop.

IDsMapOptions provides options used when created the map.

IDsMapSetUnsafeOptions is a set of options to use when setting a value with the SetUnsafe method.

PostingsMap uses the genny package to provide a generic hash map that can be specialized by running the following command from this root of the repository: ``` make hashmap-gen pkg=outpkg key_type=Type value_type=Type out_dir=/tmp ``` Or if you would like to use bytes or ident.ID as keys you can use the partially specialized maps to generate your own maps as well: ``` make byteshashmap-gen pkg=outpkg value_type=Type out_dir=/tmp make idhashmap-gen pkg=outpkg value_type=Type out_dir=/tmp ``` This will output to stdout the generated source file to use for your map.

PostingsMapEntry is an entry in the map, this is public to support iterating over the map using a native Go for loop.

PostingsMapOptions provides options used when created the map.

PostingsMapSetUnsafeOptions is a set of options to use when setting a value with the SetUnsafe method.

Options is a collection of options for segment building.

IDsMapCopyFn is the copy key function to execute when copying the key.

IDsMapEqualsFn is the equals key function to execute when detecting equality of a key.

IDsMapFinalizeFn is the finalize key function to execute when finished with a key.

IDsMapHash is the hash for a given map entry, this is public to support iterating over the map using a native Go for loop.

IDsMapHashFn is the hash function to execute when hashing a key.

PostingsMapCopyFn is the copy key function to execute when copying the key.

PostingsMapEqualsFn is the equals key function to execute when detecting equality of a key.

PostingsMapFinalizeFn is the finalize key function to execute when finished with a key.

PostingsMapHash is the hash for a given map entry, this is public to support iterating over the map using a native Go for loop.

PostingsMapHashFn is the hash function to execute when hashing a key.