-
Notifications
You must be signed in to change notification settings - Fork 451
/
types.go
96 lines (76 loc) · 3.14 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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
// Copyright (c) 2017 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 segment
import (
"errors"
"github.com/m3db/m3/src/m3ninx/index"
)
var (
// ErrClosed is the error returned when attempting to perform operations on a
// segment that has already been closed.
ErrClosed = errors.New("segment has been closed")
)
// Segment is a sub-collection of documents within an index.
type Segment interface {
// Size returns the number of documents within the Segment. It returns
// 0 if the Segment has been closed.
Size() int64
// ContainsID returns a bool indicating if the Segment contains the provided ID.
ContainsID(docID []byte) (bool, error)
// Reader returns a point-in-time accessor to search the segment.
Reader() (index.Reader, error)
// Fields returns an iterator over the list of known fields.
Fields() (FieldsIterator, error)
// Terms returns an iterator over the known terms values for the given field.
Terms(field []byte) (TermsIterator, error)
// Close closes the segment and releases any internal resources.
Close() error
}
// OrderedBytesIterator iterates over a collection of []bytes in lexicographical order.
type OrderedBytesIterator interface {
// Next returns a bool indicating if there are any more elements.
Next() bool
// Current returns the current element.
// NB: the element returned is only valid until the subsequent call to Next().
Current() []byte
// Err returns any errors encountered during iteration.
Err() error
// Close releases any resources held by the iterator.
Close() error
// Len returns the total number of elements the iterator contained at the start of iteration.
Len() int
}
// FieldsIterator iterates over all known fields.
type FieldsIterator interface {
OrderedBytesIterator
}
// TermsIterator iterates over all known terms for the provided field.
type TermsIterator interface {
OrderedBytesIterator
}
// MutableSegment is a segment which can be updated.
type MutableSegment interface {
Segment
index.Writer
// Seal marks the Mutable Segment immutable.
Seal() (Segment, error)
// IsSealed returns true iff the segment is open and un-sealed.
IsSealed() bool
}