canic-host 0.110.45

Host-side App build and desired-state Fleet reconciliation library for Canic workspaces
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

//! Module: canister_protocol::contract
//!
//! Responsibility: compare exact Candid field types for observation and effect admission.
//! Does not own: source selection, network calls or storage.
//! Boundary: parsed contracts are inspected without adapting their wire shapes.

use candid::{
    CandidType, TypeEnv,
    types::{Type, TypeInner, internal::TypeContainer},
};
use std::collections::HashSet;

/// Find one exact variant label after resolving Candid type references.
pub fn variant(env: &TypeEnv, ty: &Type, name: &str) -> Option<Type> {
    let ty = env.trace_type(ty).ok()?;
    let TypeInner::Variant(fields) = ty.as_ref() else {
        return None;
    };
    fields
        .iter()
        .find(|field| field.id.get_id() == candid::idl_hash(name))
        .map(|field| field.ty.clone())
}

/// Find one exact record field after resolving Candid type references.
pub fn record(env: &TypeEnv, ty: &Type, name: &str) -> Option<Type> {
    let ty = env.trace_type(ty).ok()?;
    let TypeInner::Record(fields) = ty.as_ref() else {
        return None;
    };
    fields
        .iter()
        .find(|field| field.id.get_id() == candid::idl_hash(name))
        .map(|field| field.ty.clone())
}

/// Require structural equality with the maintained Rust wire type.
pub fn equal<T: CandidType>(env: &mut TypeEnv, expected: &Type) -> Option<()> {
    let mut rust = TypeContainer::new();
    let ty = rust.add::<T>();
    let actual = env.merge_type(rust.env, ty);
    candid::types::subtype::equal(&mut HashSet::new(), env, expected, &actual).ok()
}