indexpb

Documentation

Overview

Package indexpb defines the storage encoding of a Bloom filter index. Most of this package is generated by the protocol buffer compiler from the schema in index/indexpb/index.proto.

Index

• Variables
• type Index
  • func (*Index) Descriptor() ([]byte, []int)
  • func (x *Index) GetHashFunc() Index_HashFunc
  • func (x *Index) GetNumKeys() uint64
  • func (x *Index) GetNumSegments() uint64
  • func (x *Index) GetSeeds() []uint64
  • func (x *Index) GetSegmentData() []byte
  • func (idx *Index) MarshalJSON() ([]byte, error)
  • func (*Index) ProtoMessage()
  • func (x *Index) ProtoReflect() protoreflect.Message
  • func (x *Index) Reset()
  • func (x *Index) String() string
• type Index_HashFunc
  • func (Index_HashFunc) Descriptor() protoreflect.EnumDescriptor
  • func (x Index_HashFunc) Enum() *Index_HashFunc
  • func (Index_HashFunc) EnumDescriptor() ([]byte, []int)
  • func (x Index_HashFunc) Number() protoreflect.EnumNumber
  • func (x Index_HashFunc) String() string
  • func (Index_HashFunc) Type() protoreflect.EnumType

Variables

var (
	Index_HashFunc_name = map[int32]string{
		0: "DEFAULT",
	}
	Index_HashFunc_value = map[string]int32{
		"DEFAULT": 0,
	}
)

Enum value maps for Index_HashFunc.

var File_index_proto protoreflect.FileDescriptor

Types

type Index

type Index struct {
	NumKeys     uint64         `protobuf:"varint,1,opt,name=num_keys,json=numKeys,proto3" json:"num_keys,omitempty"`                                  // total number of keys indexed
	Seeds       []uint64       `protobuf:"varint,2,rep,packed,name=seeds,proto3" json:"seeds,omitempty"`                                              // hash seeds used for lookup
	NumSegments uint64         `protobuf:"varint,5,opt,name=num_segments,json=numSegments,proto3" json:"num_segments,omitempty"`                      // number of bit vector segments
	SegmentData []byte         `protobuf:"bytes,6,opt,name=segment_data,json=segmentData,proto3" json:"segment_data,omitempty"`                       // zlib-compressed segment data
	HashFunc    Index_HashFunc `protobuf:"varint,4,opt,name=hash_func,json=hashFunc,proto3,enum=ffs.index.Index_HashFunc" json:"hash_func,omitempty"` // which hash function was used
	// contains filtered or unexported fields
}

An Index is the storage encoding of a Bloom filter index.

func (*Index) Descriptor

func (*Index) Descriptor() ([]byte, []int)

Deprecated: Use Index.ProtoReflect.Descriptor instead.

func (*Index) GetHashFunc

func (x *Index) GetHashFunc() Index_HashFunc

func (*Index) GetNumKeys

func (x *Index) GetNumKeys() uint64

func (*Index) GetNumSegments

func (x *Index) GetNumSegments() uint64

func (*Index) GetSeeds

func (x *Index) GetSeeds() []uint64

func (*Index) GetSegmentData

func (x *Index) GetSegmentData() []byte

func (*Index) MarshalJSON

func (idx *Index) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for an *Index, by delegating to the protojson marshaler. This allows a node to be encoded using the encoding/json package transparently.

func (*Index) ProtoMessage

func (*Index) ProtoMessage()

func (*Index) ProtoReflect

func (x *Index) ProtoReflect() protoreflect.Message

func (*Index) Reset

func (x *Index) Reset()

func (*Index) String

func (x *Index) String() string

type Index_HashFunc

type Index_HashFunc int32

const (
	Index_DEFAULT Index_HashFunc = 0
)

func (Index_HashFunc) Descriptor

func (Index_HashFunc) Descriptor() protoreflect.EnumDescriptor

func (Index_HashFunc) Enum

func (x Index_HashFunc) Enum() *Index_HashFunc

func (Index_HashFunc) EnumDescriptor

func (Index_HashFunc) EnumDescriptor() ([]byte, []int)

Deprecated: Use Index_HashFunc.Descriptor instead.

func (Index_HashFunc) Number

func (x Index_HashFunc) Number() protoreflect.EnumNumber

func (Index_HashFunc) String

func (x Index_HashFunc) String() string

func (Index_HashFunc) Type

func (Index_HashFunc) Type() protoreflect.EnumType