-
Notifications
You must be signed in to change notification settings - Fork 451
/
types.go
41 lines (36 loc) · 1.86 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
// 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 doc
// Iterator provides an iterator over a collection of documents. It is NOT safe for multiple
// goroutines to invoke methods on an Iterator simultaneously.
type Iterator interface {
// Next returns a bool indicating if the iterator has any more documents
// to return.
Next() bool
// Current returns the current document. It is only safe to call Current immediately
// after a call to Next confirms there are more elements remaining. The Document
// returned from Current is only valid until the following call to Next(). Callers
// should copy the Document if they need it live longer.
Current() Document
// Err returns any errors encountered during iteration.
Err() error
// Close releases any internal resources used by the iterator.
Close() error
}