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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
///
pub mod ancestors {
use git_hash::{oid, ObjectId};
use git_object::immutable;
use quick_error::quick_error;
use std::{
borrow::BorrowMut,
collections::{BTreeSet, VecDeque},
};
quick_error! {
/// The error is part of the item returned by the [Ancestors] iterator.
#[derive(Debug)]
#[allow(missing_docs)]
pub enum Error {
NotFound{oid: ObjectId} {
display("The object {} could not be found", oid)
}
ObjectDecode(err: immutable::object::decode::Error) {
display("An object could not be decoded")
source(err)
from()
}
}
}
/// The state used and potentially shared by multiple graph traversals.
#[derive(Default, Clone)]
pub struct State {
next: VecDeque<ObjectId>,
buf: Vec<u8>,
seen: BTreeSet<ObjectId>,
}
impl State {
fn clear(&mut self) {
self.next.clear();
self.buf.clear();
self.seen.clear();
}
}
/// An iterator over the ancestors one or more starting commits
pub struct Ancestors<Find, StateMut> {
find: Find,
state: StateMut,
}
impl<Find, StateMut> Ancestors<Find, StateMut>
where
Find: for<'a> FnMut(&oid, &'a mut Vec<u8>) -> Option<immutable::CommitIter<'a>>,
StateMut: BorrowMut<State>,
{
/// Create a new instance.
///
/// * `find` - a way to lookup new object data during traversal by their ObjectId, writing their data into buffer and returning
/// an iterator over commit tokens if the object is present and is a commit. Caching should be implemented within this function
/// as needed. The return value is `Option<CommitIter>` which degenerates all error information. Not finding a commit should also
/// be considered an errors as all objects in the commit graph should be present in the database. Hence [`Error::NotFound`] should
/// be escalated into a more specific error if its encountered by the caller.
/// * `state` - all state used for the traversal. If multiple traversals are performed, allocations can be minimized by reusing
/// this state.
/// * `tips`
/// * the starting points of the iteration, usually commits
/// * each commit they lead to will only be returned once, including the tip that started it
pub fn new(tips: impl IntoIterator<Item = impl Into<ObjectId>>, mut state: StateMut, find: Find) -> Self {
{
let state = state.borrow_mut();
state.clear();
state.next.extend(tips.into_iter().map(Into::into));
state.seen.extend(state.next.iter().cloned());
}
Ancestors { find, state }
}
}
impl<Find, StateMut> Iterator for Ancestors<Find, StateMut>
where
Find: for<'a> FnMut(&oid, &'a mut Vec<u8>) -> Option<immutable::CommitIter<'a>>,
StateMut: BorrowMut<State>,
{
type Item = Result<ObjectId, Error>;
fn next(&mut self) -> Option<Self::Item> {
let state = self.state.borrow_mut();
let res = state.next.pop_front();
if let Some(oid) = res {
match (self.find)(&oid, &mut state.buf) {
Some(mut commit_iter) => {
if let Some(Err(decode_tree_err)) = commit_iter.next() {
return Some(Err(decode_tree_err.into()));
}
for token in commit_iter {
match token {
Ok(immutable::commit::iter::Token::Parent { id }) => {
let was_inserted = state.seen.insert(id);
if was_inserted {
state.next.push_back(id);
}
}
Ok(_a_token_past_the_parents) => break,
Err(err) => return Some(Err(err.into())),
}
}
}
None => return Some(Err(Error::NotFound { oid })),
}
}
res.map(Ok)
}
}
}
#[doc(inline)]
pub use ancestors::Ancestors;