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

use crate::internal::*;

/// Wrapper around Irmin repo
pub struct Repo<T: Contents> {
    pub config: Config<T>,
    pub ptr: *mut IrminRepo,
}

impl<T: Contents> Repo<T> {
    /// Create a new repo from the given config
    pub fn new(config: Config<T>) -> Result<Repo<T>, Error> {
        unsafe {
            let ptr = irmin_repo_new(config.ptr);
            if ptr.is_null() {
                return Err(Error::NullPtr);
            }
            Ok(Repo { config, ptr })
        }
    }

    /// Get a list of all branches
    pub fn branches(&self) -> Result<Vec<IrminString>, Error> {
        let b = unsafe { irmin_repo_branches(self.ptr) };
        check!(self.ptr, b);
        let mut dest = Vec::new();
        let n = unsafe { irmin_branch_array_length(self.ptr, b) };
        for i in 0..n {
            let p = unsafe { irmin_branch_array_get(self.ptr, b, i) };
            if let Ok(s) = IrminString::wrap(p) {
                dest.push(s);
            }
        }
        unsafe { irmin_branch_array_free(b) };
        Ok(dest)
    }

    /// Create a new path
    pub fn path(&self, s: &[impl AsRef<str>]) -> Result<Path, Error> {
        Path::new(self, s)
    }

    /// Create a new commit
    pub fn commit<'a>(
        &'a self,
        parents: impl AsRef<[&'a Commit<'a>]>,
        tree: &Tree<T>,
        info: Info,
    ) -> Result<Commit<'a>, Error> {
        Commit::new(self, parents, tree, info)
    }

    /// Create an empty tree
    pub fn tree(&self) -> Result<Tree<T>, Error> {
        Tree::new(self)
    }

    /// Create commit info
    pub fn info(&self, author: impl AsRef<str>, message: impl AsRef<str>) -> Result<Info, Error> {
        Info::new(self, author, message)
    }
}

impl<T: Contents> Drop for Repo<T> {
    fn drop(&mut self) {
        unsafe { irmin_repo_free(self.ptr) }
    }
}