stash: remove now superfluos help for "stash push"
[git.git] / oidset.h
blobf4c9e0f9c04e71440aee3c1382297cbf8b1c7827
1 #ifndef OIDSET_H
2 #define OIDSET_H
4 #include "oidmap.h"
6 /**
7 * This API is similar to sha1-array, in that it maintains a set of object ids
8 * in a memory-efficient way. The major differences are:
10 * 1. It uses a hash, so we can do online duplicate removal, rather than
11 * sort-and-uniq at the end. This can reduce memory footprint if you have
12 * a large list of oids with many duplicates.
14 * 2. The per-unique-oid memory footprint is slightly higher due to hash
15 * table overhead.
18 /**
19 * A single oidset; should be zero-initialized (or use OIDSET_INIT).
21 struct oidset {
22 struct oidmap map;
25 #define OIDSET_INIT { OIDMAP_INIT }
27 /**
28 * Returns true iff `set` contains `oid`.
30 int oidset_contains(const struct oidset *set, const struct object_id *oid);
32 /**
33 * Insert the oid into the set; a copy is made, so "oid" does not need
34 * to persist after this function is called.
36 * Returns 1 if the oid was already in the set, 0 otherwise. This can be used
37 * to perform an efficient check-and-add.
39 int oidset_insert(struct oidset *set, const struct object_id *oid);
41 /**
42 * Remove all entries from the oidset, freeing any resources associated with
43 * it.
45 void oidset_clear(struct oidset *set);
47 #endif /* OIDSET_H */