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.Type
pub struct Type {
    pub ptr: *mut IrminType,
}

impl Clone for Type {
    fn clone(&self) -> Type {
        let ptr = unsafe { irmin_value_clone(self.ptr as *mut _) as *mut IrminType };
        Type { ptr }
    }
}

impl Drop for Type {
    fn drop(&mut self) {
        unsafe { irmin_type_free(self.ptr) }
    }
}

impl Type {
    /// Irmin.Type.string
    pub fn string() -> Result<Type, Error> {
        let ptr = unsafe { irmin_type_string() };
        if ptr.is_null() {
            return Err(Error::NullPtr);
        };
        Ok(Type { ptr })
    }

    /// Irmin.Type.int
    pub fn int() -> Result<Type, Error> {
        let ptr = unsafe { irmin_type_int() };
        if ptr.is_null() {
            return Err(Error::NullPtr);
        };
        Ok(Type { ptr })
    }

    /// Irmin.Type.float
    pub fn float() -> Result<Type, Error> {
        let ptr = unsafe { irmin_type_float() };
        if ptr.is_null() {
            return Err(Error::NullPtr);
        };
        Ok(Type { ptr })
    }

    /// Irmin.Type.bool
    pub fn bool() -> Result<Type, Error> {
        let ptr = unsafe { irmin_type_bool() };
        if ptr.is_null() {
            return Err(Error::NullPtr);
        };
        Ok(Type { ptr })
    }

    /// Irmin.Contents.Json.t
    pub fn json() -> Result<Type, Error> {
        let ptr = unsafe { irmin_type_json() };
        if ptr.is_null() {
            return Err(Error::NullPtr);
        };
        Ok(Type { ptr })
    }

    /// Irmin.Contents.Json_value.t
    pub fn json_value() -> Result<Type, Error> {
        let ptr = unsafe { irmin_type_json_value() };
        if ptr.is_null() {
            return Err(Error::NullPtr);
        };
        Ok(Type { ptr })
    }

    /// The path type for a Repo
    pub fn path<T: Contents>(repo: &Repo<T>) -> Result<Type, Error> {
        let ptr = unsafe { irmin_type_path(repo.ptr) };
        check!(repo.ptr, ptr);
        Ok(Type { ptr })
    }

    /// The hash type for a Repo
    pub fn hash<T: Contents>(repo: &Repo<T>) -> Result<Type, Error> {
        let ptr = unsafe { irmin_type_hash(repo.ptr) };
        check!(repo.ptr, ptr);
        Ok(Type { ptr })
    }

    /// The commit type for a Repo
    pub fn commit<T: Contents>(repo: &Repo<T>) -> Result<Type, Error> {
        let ptr = unsafe { irmin_type_commit(repo.ptr) };
        check!(repo.ptr, ptr);
        Ok(Type { ptr })
    }

    pub fn commit_key<T: Contents>(repo: &Repo<T>) -> Result<Type, Error> {
        let ptr = unsafe { irmin_type_commit_key(repo.ptr) };
        check!(repo.ptr, ptr);
        Ok(Type { ptr })
    }

    pub fn kinded_key<T: Contents>(repo: &Repo<T>) -> Result<Type, Error> {
        let ptr = unsafe { irmin_type_kinded_key(repo.ptr) };
        check!(repo.ptr, ptr);
        Ok(Type { ptr })
    }

    pub fn metadata<T: Contents>(repo: &Repo<T>) -> Result<Type, Error> {
        let ptr = unsafe { irmin_type_metadata(repo.ptr) };
        check!(repo.ptr, ptr);
        Ok(Type { ptr })
    }

    pub fn contents<T: Contents>(repo: &Repo<T>) -> Result<Type, Error> {
        let ptr = unsafe { irmin_type_contents(repo.ptr) };
        check!(repo.ptr, ptr);
        Ok(Type { ptr })
    }

    /// The tree type for a Repo
    pub fn tree<T: Contents>(repo: &Repo<T>) -> Result<Type, Error> {
        let ptr = unsafe { irmin_type_tree(repo.ptr) };
        check!(repo.ptr, ptr);
        Ok(Type { ptr })
    }

    /// Get the name of a type
    pub fn name(&self) -> Result<IrminString, Error> {
        let name = unsafe { irmin_type_name(self.ptr) };
        IrminString::wrap(name)
    }
}