diff options
author | Han-Wen Nienhuys <hanwen@google.com> | 2021-10-07 23:25:07 +0300 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2021-10-08 20:45:48 +0300 |
commit | 17df8dbeba18c8c36f14c58815a03091ba61f895 (patch) | |
tree | 63dbbfc6297322f47ad56b333becfac5ff31944e /reftable/reftable-iterator.h | |
parent | f14bd7193490d9a8d42306dcc750b73aa26defdc (diff) |
reftable: generic interface to tables
Signed-off-by: Han-Wen Nienhuys <hanwen@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'reftable/reftable-iterator.h')
-rw-r--r-- | reftable/reftable-iterator.h | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/reftable/reftable-iterator.h b/reftable/reftable-iterator.h new file mode 100644 index 0000000000..d3eee7af35 --- /dev/null +++ b/reftable/reftable-iterator.h @@ -0,0 +1,39 @@ +/* +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; +}; + +/* 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); + +/* 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 |