mirror of
https://github.com/git/git
synced 2024-06-30 22:54:27 +00:00
d76f0d3f57
Refactor the interfaces exposed by `struct reftable_table` and `struct reftable_iterator` such that they support iterator reuse. This is done by separating initialization of the iterator and seeking on it. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
61 lines
1.7 KiB
C
61 lines
1.7 KiB
C
/*
|
|
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
|