xvc-core 0.7.0

Xvc core for common elements for all commands
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184

//! ECS utilities for easy load and save in a repository.
use crate::error::Result;
use crate::types::xvcroot::XvcRootInner;
use xvc_ecs::R11Store;
use xvc_ecs::R1NStore;
use xvc_ecs::RMNStore;
use xvc_ecs::Storable;
use xvc_ecs::XvcStore;

impl XvcRootInner {
    /// Load XvcStore from the repository stores
    pub fn load_store<T>(&self) -> Result<XvcStore<T>>
    where
        T: Storable,
    {
        Ok(XvcStore::<T>::load_store(self.store_dir())?)
    }

    /// Utility function to save a [xvc_ecs::XvcStore] in a repository.
    pub fn save_store<T>(&self, store: &XvcStore<T>) -> Result<()>
    where
        T: Storable,
    {
        Ok(XvcStore::<T>::save_store(store, self.store_dir())?)
    }

    /// Loads a [xvc_ecs::XvcStore] and runs the given closure with it.
    pub fn with_store<T>(&self, mut f: impl FnMut(&XvcStore<T>) -> Result<()>) -> Result<()>
    where
        T: Storable,
    {
        let store = self.load_store::<T>()?;
        f(&store)
    }

    /// Loads a [xvc_ecs::XvcStore], runs the given closure with it and saves the store.
    /// Closure is used to modify the store elements.
    pub fn with_store_mut<T>(&self, mut f: impl FnMut(&mut XvcStore<T>) -> Result<()>) -> Result<()>
    where
        T: Storable,
    {
        let mut store = self.load_store::<T>()?;
        f(&mut store)?;
        self.save_store(&store)
    }

    /// Utility function to load a [xvc_ecs::R11Store] in a repository.
    pub fn load_r11store<T, U>(&self) -> Result<R11Store<T, U>>
    where
        T: Storable,
        U: Storable,
    {
        Ok(R11Store::<T, U>::load_r11store(self.store_dir())?)
    }

    /// Utility function to load a [xvc_ecs::R1NStore] in a repository.
    pub fn load_r1nstore<T, U>(&self) -> Result<R1NStore<T, U>>
    where
        T: Storable,
        U: Storable,
    {
        Ok(R1NStore::<T, U>::load_r1nstore(self.store_dir())?)
    }

    /// Utility function to load a [xvc_ecs::RMNStore] in a repository.
    pub fn load_rmnstore<T, U>(&self) -> Result<RMNStore<T, U>>
    where
        T: Storable,
        U: Storable,
    {
        Ok(RMNStore::<T, U>::load_rmnstore(self.store_dir())?)
    }

    /// Utility function to save a [xvc_ecs::R11Store] in a repository.
    pub fn save_r11store<T, U>(&self, store: &R11Store<T, U>) -> Result<()>
    where
        T: Storable,
        U: Storable,
    {
        Ok(R11Store::<T, U>::save_r11store(store, self.store_dir())?)
    }

    /// Utility function to save a [xvc_ecs::R1NStore] in a repository.
    pub fn save_r1nstore<T, U>(&self, store: &R1NStore<T, U>) -> Result<()>
    where
        T: Storable,
        U: Storable,
    {
        Ok(R1NStore::<T, U>::save_r1nstore(store, self.store_dir())?)
    }

    /// Utility function to save a [xvc_ecs::RMNStore] in a repository.
    pub fn save_rmnstore<T, U>(&self, store: &RMNStore<T, U>) -> Result<()>
    where
        T: Storable,
        U: Storable,
    {
        Ok(RMNStore::<T, U>::save_rmnstore(store, self.store_dir())?)
    }

    /// Loads a [xvc_ecs::R11Store] and runs the given closure with it.
    pub fn with_r11store<T, U>(
        &self,
        mut f: impl FnMut(&R11Store<T, U>) -> Result<()>,
    ) -> Result<()>
    where
        T: Storable,
        U: Storable,
    {
        let store = self.load_r11store::<T, U>()?;
        f(&store)
    }

    /// Loads a [xvc_ecs::R1NStore] and runs the given closure with it.
    pub fn with_r1nstore<T, U>(
        &self,
        mut f: impl FnMut(&R1NStore<T, U>) -> Result<()>,
    ) -> Result<()>
    where
        T: Storable,
        U: Storable,
    {
        let store = self.load_r1nstore::<T, U>()?;
        f(&store)
    }

    /// Loads a [xvc_ecs::RMNStore] and runs the given closure with it.
    pub fn with_rmnstore<T, U>(
        &self,
        mut f: impl FnMut(&RMNStore<T, U>) -> Result<()>,
    ) -> Result<()>
    where
        T: Storable,
        U: Storable,
    {
        let store = self.load_rmnstore::<T, U>()?;
        f(&store)
    }

    /// Loads a [xvc_ecs::R11Store], runs the given closure with it and saves the store.
    /// Closure is used to modify the store elements.
    pub fn with_r11store_mut<T, U>(
        &self,
        f: impl Fn(&mut R11Store<T, U>) -> Result<()>,
    ) -> Result<()>
    where
        T: Storable,
        U: Storable,
    {
        let mut store = self.load_r11store::<T, U>()?;

        f(&mut store)?;

        self.save_r11store::<T, U>(&store)
    }
    /// Loads a [xvc_ecs::R1NStore], runs the given closure with it and saves the store.
    /// Closure is used to modify the store elements.
    pub fn with_r1nstore_mut<T, U>(
        &self,
        f: impl Fn(&mut R1NStore<T, U>) -> Result<()>,
    ) -> Result<()>
    where
        T: Storable,
        U: Storable,
    {
        let mut store = self.load_r1nstore::<T, U>()?;
        f(&mut store)?;
        self.save_r1nstore::<T, U>(&store)
    }
    /// Loads a [xvc_ecs::RMNStore], runs the given closure with it and saves the store.
    /// Closure is used to modify the store elements.
    pub fn with_rmnstore_mut<T, U>(
        &self,
        f: impl Fn(&mut RMNStore<T, U>) -> Result<()>,
    ) -> Result<()>
    where
        T: Storable,
        U: Storable,
    {
        let mut store = self.load_rmnstore::<T, U>()?;
        f(&mut store)?;
        self.save_rmnstore::<T, U>(&store)
    }
}