ockam_api 0.49.0

Ockam's request-response API
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

use crate::cloud::space::Space;
use ockam_core::async_trait;
use ockam_core::Result;

/// This trait supports the storage of spaces as retrieved from the Controller
///
///  - in addition to the space data, we can set a space as the default space
///  - a space is identified by its id by default when getting it or setting it as the default
///
#[async_trait]
pub trait SpacesRepository: Send + Sync + 'static {
    /// Store a space
    async fn store_space(&self, space: &Space) -> Result<()>;

    /// Return a space for a given id
    async fn get_space(&self, space_id: &str) -> Result<Option<Space>>;

    /// Return a space for a given name
    async fn get_space_by_name(&self, name: &str) -> Result<Option<Space>>;

    /// Return the list of all spaces
    async fn get_spaces(&self) -> Result<Vec<Space>>;

    /// Return the default space
    async fn get_default_space(&self) -> Result<Option<Space>>;

    /// Set a space as the default one
    async fn set_default_space(&self, space_id: &str) -> Result<()>;

    /// Delete a space
    async fn delete_space(&self, space_id: &str) -> Result<()>;
}