canic-core 0.35.7

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

pub mod adapter;

use crate::{InternalError, dto::http, ops::ic::http::HttpOps};

///
/// HttpWorkflow
///

pub struct HttpWorkflow;

impl HttpWorkflow {
    /// Perform a GET request and return the raw response.
    /// Prefer `get_with_label` when the URL path can contain unbounded values.
    pub async fn get(
        url: &str,
        headers: &[(&str, &str)],
    ) -> Result<http::HttpRequestResult, InternalError> {
        let res = HttpOps::get(url, headers).await?;
        Ok(adapter::HttpAdapter::result_to_dto(res))
    }

    /// Same as `get`, with an explicit metrics label.
    /// The label should identify a stable provider or route, not a request-specific value.
    pub async fn get_with_label(
        url: &str,
        headers: &[(&str, &str)],
        label: &str,
    ) -> Result<http::HttpRequestResult, InternalError> {
        let res = HttpOps::get_with_label(url, headers, Some(label)).await?;
        Ok(adapter::HttpAdapter::result_to_dto(res))
    }

    pub async fn get_raw(
        args: http::HttpRequestArgs,
    ) -> Result<http::HttpRequestResult, InternalError> {
        Self::get_raw_with_label(args, None).await
    }

    /// Perform a raw HTTP request with an optional metrics label.
    /// Pass a stable label whenever the raw URL contains request-specific path data.
    pub async fn get_raw_with_label(
        args: http::HttpRequestArgs,
        label: Option<&str>,
    ) -> Result<http::HttpRequestResult, InternalError> {
        let infra_args = adapter::HttpAdapter::request_args_from_dto(args);
        let res = HttpOps::get_raw_with_label(infra_args, label).await?;

        Ok(adapter::HttpAdapter::result_to_dto(res))
    }
}