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

//
// Wildland Project
//
// Copyright © 2022 Golem Foundation
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License version 3 as published by
// the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

use std::sync::Arc;

use uuid::Uuid;

use super::entities::{ContainerManifest, Devices, ForestManifest, WildlandPubKey};
use super::error::CatlibResult;

#[cfg_attr(test, mockall::automock)]
pub trait CatLib: Send + Sync {
    /// Create new Forest object.
    ///
    /// `owner` and `devices` are cryptographical objects that are used by the Core module to
    /// verify the cryptographical integrity of the manifests.
    ///
    /// `data` is an arbitrary data object that can be used to synchronize Forest state between
    /// devices.
    fn create_forest(
        &self,
        owner: WildlandPubKey,
        devices: Devices,
        data: Vec<u8>,
    ) -> CatlibResult<Arc<dyn ForestManifest>>;

    fn get_forest(&self, owner: &WildlandPubKey) -> CatlibResult<Arc<dyn ForestManifest>>;

    /// Return [`crate::Container`] object by Container UUID.
    fn get_container(&self, uuid: Uuid) -> CatlibResult<Arc<dyn ContainerManifest>>;

    /// Check if database backend is available
    fn is_db_alive(&self) -> CatlibResult<()>;
}