irmin 0.3.3

Irmin bindings for rust
Documentation 
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

use crate::internal::*;

/// Wrapper around Irmin commits
pub struct Commit<'a> {
    pub ptr: *mut IrminCommit,
    pub(crate) repo: UntypedRepo<'a>,
}

impl<'a> Drop for Commit<'a> {
    fn drop(&mut self) {
        unsafe { irmin_commit_free(self.ptr) }
    }
}

impl<'a> PartialEq for Commit<'a> {
    fn eq(&self, other: &Commit<'a>) -> bool {
        unsafe { irmin_commit_equal(self.repo.ptr, self.ptr, other.ptr) }
    }
}

impl<'a> Commit<'a> {
    /// Create a new commit
    pub fn new<T: Contents>(
        repo: &'a Repo<T>,
        parents: impl AsRef<[&'a Commit<'a>]>,
        tree: &Tree<T>,
        info: Info,
    ) -> Result<Commit<'a>, Error> {
        let parents: Vec<_> = parents.as_ref().iter().map(|x| x.ptr).collect();
        let ptr = unsafe {
            irmin_commit_new(
                repo.ptr,
                parents.as_ptr() as *mut _,
                parents.len() as u64,
                tree.ptr,
                info.ptr,
            )
        };
        check!(repo.ptr, ptr);
        Ok(Commit {
            ptr,
            repo: UntypedRepo::new(repo),
        })
    }

    /// Find the commit associated with the given hash
    pub fn of_hash<T: Contents>(
        repo: &'a Repo<T>,
        hash: &Hash,
    ) -> Result<Option<Commit<'a>>, Error> {
        let ptr = unsafe { irmin_commit_of_hash(repo.ptr, hash.ptr) };
        check_opt!(repo.ptr, ptr);
        Ok(Some(Commit {
            ptr,
            repo: UntypedRepo::new(repo),
        }))
    }

    /// Get the hash associated with a commit
    pub fn hash(&self) -> Result<Hash, Error> {
        let ptr = unsafe { irmin_commit_hash(self.repo.ptr, self.ptr) };
        check!(self.repo.ptr, ptr);
        Ok(Hash {
            ptr,
            repo: self.repo.clone(),
        })
    }

    /// Find the commit associated with the given key
    pub fn of_key<T: Contents>(
        repo: &'a Repo<T>,
        key: &CommitKey,
    ) -> Result<Option<Commit<'a>>, Error> {
        let ptr = unsafe { irmin_commit_of_key(repo.ptr, key.ptr) };
        check_opt!(repo.ptr, ptr);
        Ok(Some(Commit {
            ptr,
            repo: UntypedRepo::new(repo),
        }))
    }

    /// Get the key associated with a commit
    pub fn key(&self) -> Result<CommitKey, Error> {
        let ptr = unsafe { irmin_commit_key(self.repo.ptr, self.ptr) };
        check!(self.repo.ptr, ptr);
        Ok(CommitKey {
            ptr,
            repo: self.repo.clone(),
        })
    }

    /// Get commit info
    pub fn info(&self) -> Result<Info, Error> {
        let ptr = unsafe { irmin_commit_info(self.repo.ptr, self.ptr) };
        check!(self.repo.ptr, ptr);
        Ok(Info {
            ptr,
            repo: self.repo.clone(),
        })
    }

    pub fn tree<T: Contents>(&self) -> Result<Tree<T>, Error> {
        let ptr = unsafe { irmin_commit_tree(self.repo.ptr, self.ptr) };
        check!(self.repo.ptr, ptr);
        Ok(Tree {
            ptr,
            repo: self.repo.clone(),
            _t: std::marker::PhantomData,
        })
    }

    /// Get commit parents
    pub fn parents(&self) -> Result<Vec<Commit>, Error> {
        let p = unsafe { irmin_commit_parents(self.repo.ptr, self.ptr) };
        check!(self.repo.ptr, p);
        let len = unsafe { irmin_commit_array_length(self.repo.ptr, p) };
        let mut dest = Vec::new();
        for i in 0..len {
            let c = unsafe { irmin_commit_array_get(self.repo.ptr, p, i) };
            if c.is_null() {
                continue;
            }
            dest.push(Commit {
                ptr: c,
                repo: self.repo.clone(),
            })
        }

        unsafe { irmin_commit_array_free(p) }

        Ok(dest)
    }
}