fswriter

Documentation

Overview

Package fswriter is a generated protocol buffer package.

It is generated from these files:

github.com/m3db/m3/src/m3ninx/generated/proto/fswriter/fswriter.proto

It has these top-level messages:

Metadata
FieldData

Index

• Variables
• type FSTSegmentFileType
  • func (FSTSegmentFileType) EnumDescriptor() ([]byte, []int)
  • func (x FSTSegmentFileType) String() string
• type FieldData
  • func (*FieldData) Descriptor() ([]byte, []int)
  • func (m *FieldData) GetFieldPostingsListOffset() uint64
  • func (m *FieldData) Marshal() (dAtA []byte, err error)
  • func (m *FieldData) MarshalTo(dAtA []byte) (int, error)
  • func (*FieldData) ProtoMessage()
  • func (m *FieldData) Reset()
  • func (m *FieldData) Size() (n int)
  • func (m *FieldData) String() string
  • func (m *FieldData) Unmarshal(dAtA []byte) error
• type Metadata
  • func (*Metadata) Descriptor() ([]byte, []int)
  • func (m *Metadata) GetNumDocs() int64
  • func (m *Metadata) GetPostingsFormat() PostingsFormat
  • func (m *Metadata) Marshal() (dAtA []byte, err error)
  • func (m *Metadata) MarshalTo(dAtA []byte) (int, error)
  • func (*Metadata) ProtoMessage()
  • func (m *Metadata) Reset()
  • func (m *Metadata) Size() (n int)
  • func (m *Metadata) String() string
  • func (m *Metadata) Unmarshal(dAtA []byte) error
• type PostingsFormat
  • func (PostingsFormat) EnumDescriptor() ([]byte, []int)
  • func (x PostingsFormat) String() string
• type SegmentType
  • func (SegmentType) EnumDescriptor() ([]byte, []int)
  • func (x SegmentType) String() string

Variables

var (
	ErrInvalidLengthFswriter = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowFswriter   = fmt.Errorf("proto: integer overflow")
)

var FSTSegmentFileType_name = map[int32]string{
	0: "DOCUMENTS_INDEX",
	1: "DOCUMENTS_DATA",
	2: "POSTINGS_DATA",
	3: "FST_TERMS",
	4: "FST_FIELDS",
}

var FSTSegmentFileType_value = map[string]int32{
	"DOCUMENTS_INDEX": 0,
	"DOCUMENTS_DATA":  1,
	"POSTINGS_DATA":   2,
	"FST_TERMS":       3,
	"FST_FIELDS":      4,
}

var PostingsFormat_name = map[int32]string{
	0: "PILOSAV1_POSTINGS_FORMAT",
}

var PostingsFormat_value = map[string]int32{
	"PILOSAV1_POSTINGS_FORMAT": 0,
}

var SegmentType_name = map[int32]string{
	0: "FST_SEGMENT_TYPE",
}

var SegmentType_value = map[string]int32{
	"FST_SEGMENT_TYPE": 0,
}

Types

type FSTSegmentFileType

type FSTSegmentFileType int32

const (
	FSTSegmentFileType_DOCUMENTS_INDEX FSTSegmentFileType = 0
	FSTSegmentFileType_DOCUMENTS_DATA  FSTSegmentFileType = 1
	FSTSegmentFileType_POSTINGS_DATA   FSTSegmentFileType = 2
	FSTSegmentFileType_FST_TERMS       FSTSegmentFileType = 3
	FSTSegmentFileType_FST_FIELDS      FSTSegmentFileType = 4
)

func (FSTSegmentFileType) EnumDescriptor

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

func (FSTSegmentFileType) String

func (x FSTSegmentFileType) String() string

type FieldData

type FieldData struct {
	// postingsOffset for the pl corresponding to the union of all documents
	// which have a given field.
	FieldPostingsListOffset uint64 `protobuf:"varint,1,opt,name=fieldPostingsListOffset,proto3" json:"fieldPostingsListOffset,omitempty"`
}

additional metadata stored per Field in the corpus.

func (*FieldData) Descriptor

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

func (*FieldData) GetFieldPostingsListOffset

func (m *FieldData) GetFieldPostingsListOffset() uint64

func (*FieldData) Marshal

func (m *FieldData) Marshal() (dAtA []byte, err error)

func (*FieldData) MarshalTo

func (m *FieldData) MarshalTo(dAtA []byte) (int, error)

func (*FieldData) ProtoMessage

func (*FieldData) ProtoMessage()

func (*FieldData) Reset

func (m *FieldData) Reset()

func (*FieldData) Size

func (m *FieldData) Size() (n int)

func (*FieldData) String

func (m *FieldData) String() string

func (*FieldData) Unmarshal

func (m *FieldData) Unmarshal(dAtA []byte) error

type Metadata

type Metadata struct {
	PostingsFormat PostingsFormat `protobuf:"varint,1,opt,name=postingsFormat,proto3,enum=fswriter.PostingsFormat" json:"postingsFormat,omitempty"`
	NumDocs        int64          `protobuf:"varint,2,opt,name=numDocs,proto3" json:"numDocs,omitempty"`
}

func (*Metadata) Descriptor

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

func (*Metadata) GetNumDocs

func (m *Metadata) GetNumDocs() int64

func (*Metadata) GetPostingsFormat

func (m *Metadata) GetPostingsFormat() PostingsFormat

func (*Metadata) Marshal

func (m *Metadata) Marshal() (dAtA []byte, err error)

func (*Metadata) MarshalTo

func (m *Metadata) MarshalTo(dAtA []byte) (int, error)

func (*Metadata) ProtoMessage

func (*Metadata) ProtoMessage()

func (*Metadata) Reset

func (m *Metadata) Reset()

func (*Metadata) Size

func (m *Metadata) Size() (n int)

func (*Metadata) String

func (m *Metadata) String() string

func (*Metadata) Unmarshal

func (m *Metadata) Unmarshal(dAtA []byte) error

type PostingsFormat

type PostingsFormat int32

const (
	PostingsFormat_PILOSAV1_POSTINGS_FORMAT PostingsFormat = 0
)

func (PostingsFormat) EnumDescriptor

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

func (PostingsFormat) String

func (x PostingsFormat) String() string

type SegmentType

type SegmentType int32

const (
	SegmentType_FST_SEGMENT_TYPE SegmentType = 0
)

func (SegmentType) EnumDescriptor

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

func (SegmentType) String

func (x SegmentType) String() string