github.com/creachadair/ffs@v0.17.3/index/indexpb/index.proto (about)

     1  // Copyright 2021 Michael J. Fromberger. All Rights Reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // This schema defines a storage encoding for a Bloom filter index.
    16  syntax = "proto3";
    17  
    18  package ffs.index;
    19  option go_package = "github.com/creachadair/ffs/index/indexpb";
    20  
    21  // An Index is the storage encoding of a Bloom filter index.
    22  message Index {
    23    uint64 num_keys = 1;        // total number of keys indexed
    24    repeated uint64 seeds = 2;  // hash seeds used for lookup
    25    uint64 num_segments = 5;    // number of bit vector segments
    26    bytes segment_data = 6;     // zlib-compressed segment data
    27    HashFunc hash_func = 4;     // which hash function was used
    28  
    29    enum HashFunc { DEFAULT = 0; }
    30  
    31    reserved 3;  // was: segments vector
    32  }