canic-core 0.100.17

Canic — a canister orchestration and management toolkit for the Internet Computer
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

use crate::{
    cdk::types::Principal,
    dto::{
        error::Error,
        placement::index::{
            PlacementIndexRecoveryResponse, PlacementIndexRegistryResponse,
            PlacementIndexStatusResponse,
        },
    },
    workflow::placement::index::{PlacementIndexWorkflow, query::PlacementIndexQuery},
};

///
/// PlacementIndexApi
///

pub struct PlacementIndexApi;

impl PlacementIndexApi {
    #[must_use]
    pub fn lookup_key(pool: &str, key_value: &str) -> Option<Principal> {
        PlacementIndexQuery::lookup_key(pool, key_value)
    }

    #[must_use]
    pub fn lookup_entry(pool: &str, key_value: &str) -> Option<PlacementIndexStatusResponse> {
        PlacementIndexQuery::lookup_entry(pool, key_value)
    }

    pub async fn recover_entry(
        pool: &str,
        key_value: impl AsRef<str>,
    ) -> Result<PlacementIndexRecoveryResponse, Error> {
        PlacementIndexWorkflow::recover_entry(pool, key_value.as_ref())
            .await
            .map_err(Error::from)
    }

    pub async fn resolve_or_create(
        pool: &str,
        key_value: impl AsRef<str>,
    ) -> Result<PlacementIndexStatusResponse, Error> {
        PlacementIndexWorkflow::resolve_or_create(pool, key_value.as_ref())
            .await
            .map_err(Error::from)
    }

    pub fn bind_instance(
        pool: &str,
        key_value: impl AsRef<str>,
        pid: Principal,
    ) -> Result<(), Error> {
        PlacementIndexWorkflow::bind_instance(pool, key_value.as_ref(), pid).map_err(Error::from)
    }

    #[must_use]
    pub fn registry() -> PlacementIndexRegistryResponse {
        PlacementIndexQuery::registry()
    }
}