-
Notifications
You must be signed in to change notification settings - Fork 27.6k
Expand file tree
/
Copy pathreftable-iterator.h
More file actions
60 lines (49 loc) · 1.73 KB
/
reftable-iterator.h
File metadata and controls
60 lines (49 loc) · 1.73 KB
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
/*
* Copyright 2020 Google LLC
*
* Use of this source code is governed by a BSD-style
* license that can be found in the LICENSE file or at
* https://developers.google.com/open-source/licenses/bsd
*/
#ifndef REFTABLE_ITERATOR_H
#define REFTABLE_ITERATOR_H
#include "reftable-record.h"
struct reftable_iterator_vtable;
/* iterator is the generic interface for walking over data stored in a
* reftable.
*/
struct reftable_iterator {
struct reftable_iterator_vtable *ops;
void *iter_arg;
};
/*
* Position the iterator at the ref record with given name such that the next
* call to `next_ref()` would yield the record.
*/
int reftable_iterator_seek_ref(struct reftable_iterator *it,
const char *name);
/* reads the next reftable_ref_record. Returns < 0 for error, 0 for OK and > 0:
* end of iteration.
*/
int reftable_iterator_next_ref(struct reftable_iterator *it,
struct reftable_ref_record *ref);
/*
* Position the iterator at the log record with given name and update index
* such that the next call to `next_log()` would yield the record.
*/
int reftable_iterator_seek_log_at(struct reftable_iterator *it,
const char *name, uint64_t update_index);
/*
* Position the iterator at the newest log record with given name such that the
* next call to `next_log()` would yield the record.
*/
int reftable_iterator_seek_log(struct reftable_iterator *it,
const char *name);
/* reads the next reftable_log_record. Returns < 0 for error, 0 for OK and > 0:
* end of iteration.
*/
int reftable_iterator_next_log(struct reftable_iterator *it,
struct reftable_log_record *log);
/* releases resources associated with an iterator. */
void reftable_iterator_destroy(struct reftable_iterator *it);
#endif