-
Notifications
You must be signed in to change notification settings - Fork 451
/
types.go
79 lines (63 loc) · 2.71 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
// Copyright (c) 2018 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package fst
import (
"io"
"github.com/m3db/m3/src/m3ninx/index"
sgmt "github.com/m3db/m3/src/m3ninx/index/segment"
)
const (
magicNumber = 0x6D33D0C5
// MajorVersion is the currently supported MajorVersion.
MajorVersion = 1
// MinorVersion is the current MinorVersion.
MinorVersion = 0
)
// Segment represents a FST segment.
type Segment interface {
sgmt.Segment
index.Readable
}
// Writer writes out a FST segment from the provided elements.
type Writer interface {
// Reset sets the Writer to persist the provide segment.
// NB(prateek): if provided segment is a mutable segment it must be sealed.
Reset(s sgmt.Builder) error
// MajorVersion is the major version for the writer.
MajorVersion() int
// MinorVersion is the minor version for the writer.
MinorVersion() int
// Metadata returns metadata about the writer.
Metadata() []byte
// WriteDocumentsData writes out the documents data to the provided writer.
WriteDocumentsData(w io.Writer) error
// WriteDocumentsIndex writes out the documents index to the provided writer.
// NB(prateek): this must be called after WriteDocumentsData().
WriteDocumentsIndex(w io.Writer) error
// WritePostingsOffsets writes out the postings offset file to the provided
// writer.
WritePostingsOffsets(w io.Writer) error
// WriteFSTTerms writes out the FSTTerms file using the provided writer.
// NB(prateek): this must be called after WritePostingsOffsets().
WriteFSTTerms(w io.Writer) error
// WriteFSTFields writes out the FSTFields file using the provided writer.
// NB(prateek): this must be called after WriteFSTTerm().
WriteFSTFields(w io.Writer) error
}