canic-core 0.82.39

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

//! Module: api::metadata
//!
//! Responsibility: public Canic metadata facade for endpoint callers.
//! Does not own: package metadata generation or endpoint macro emission.
//! Boundary: builds metadata DTOs from package and canister version inputs.

use crate::dto::metadata::CanicMetadataResponse;

///
/// CanicMetadataApi
///
/// Thin endpoint-facing facade for Canic metadata responses.
///

pub struct CanicMetadataApi;

impl CanicMetadataApi {
    /// Return metadata for the canister crate that exports the endpoint.
    #[must_use]
    pub fn metadata_for(
        package_name: &str,
        package_version: &str,
        package_description: &str,
        canic_version: &str,
        canister_version: u64,
    ) -> CanicMetadataResponse {
        CanicMetadataResponse {
            package_name: package_name.to_string(),
            package_version: package_version.to_string(),
            package_description: package_description.to_string(),
            canic_version: canic_version.to_string(),
            canister_version,
        }
    }
}