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

//!
use std::{borrow::Borrow, ops::DerefMut};

use git_ref::file::ReferenceExt;

use crate::{
    easy,
    easy::{reference::Logs, Reference},
};

///
pub mod init {
    use crate::easy;

    /// The error returned by [Logs::iter()][super::Logs::iter()] and [Logs::iter_rev()][super::Logs::iter_rev()].
    #[derive(Debug, thiserror::Error)]
    #[allow(missing_docs)]
    pub enum Error {
        #[error(transparent)]
        Io(#[from] std::io::Error),
        #[error(transparent)]
        BorrowRepo(#[from] easy::borrow::repo::Error),
    }
}

// TODO: use attached types with `access`
/// An iterator over reference logs, most recent to oldest.
pub type ReverseIter<'a> = git_ref::file::log::iter::Reverse<'a, std::fs::File>;
/// An iterator over reference logs, oldest to newest.
pub type ForwardIter<'a> = git_ref::file::log::iter::Forward<'a>;

impl<'repo, A, R> Logs<'repo, A, R>
where
    A: easy::Access + Sized,
    R: Borrow<Reference<'repo, A>>,
{
    /// Return a reverse iterator over reference logs, most recent to oldest.
    ///
    /// This is a typical and efficient way of accessing logs as one is interested in the most recent ones first.
    pub fn iter_rev(&mut self) -> Result<Option<ReverseIter<'_>>, init::Error> {
        let buf = self.buf.deref_mut();
        buf.resize(512, 0);
        Ok(self
            .reference
            .borrow()
            .inner
            .log_iter_rev(&self.reference.borrow().access.repo()?.refs, buf)?)
    }

    // TODO: tests
    /// Return an iterator over reference logs, from oldest to newest.
    ///
    /// The iterator is optimized for rewriting the processing or rewriting the entire log.
    /// For accessing only the most recent entries, see [`iter_rev()`][Logs::iter_rev()].
    pub fn iter(&mut self) -> Result<Option<ForwardIter<'_>>, init::Error> {
        let buf = self.buf.deref_mut();
        Ok(self
            .reference
            .borrow()
            .inner
            .log_iter(&self.reference.borrow().access.repo()?.refs, buf)?)
    }
}

impl<'repo, A> Reference<'repo, A>
where
    A: easy::Access + Sized,
{
    /// Return a platform for obtaining iterators over reference logs.
    pub fn logs(&self) -> Result<Logs<'repo, A, &'_ Reference<'repo, A>>, easy::borrow::state::Error> {
        Ok(Logs {
            reference: self,
            buf: self.access.state().try_borrow_mut_buf()?,
            _phantom: Default::default(),
        })
    }
}