canic-core 0.82.11

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
61
62
63
64
65
66
67
68
69
70
71
72
73

use crate::dto::prelude::*;

pub use crate::domain::http::HttpMethod;

//
// HttpRequestArgs
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub struct HttpRequestArgs {
    pub url: String,
    pub max_response_bytes: Option<u64>,
    pub method: HttpMethod,
    pub headers: Vec<HttpHeader>,
    pub body: Option<Vec<u8>>,
    pub is_replicated: Option<bool>,
}

//
// HttpRequestResult
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub struct HttpRequestResult {
    pub status: Nat,
    pub headers: Vec<HttpHeader>,
    #[serde(with = "serde_bytes")]
    pub body: Vec<u8>,
}

//
// HttpHeader
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub struct HttpHeader {
    pub name: String,
    pub value: String,
}

#[cfg(test)]
mod tests {
    use super::*;
    use candid::{CandidType, Decode, Encode};
    use serde::Deserialize;

    #[expect(
        clippy::upper_case_acronyms,
        reason = "legacy HTTP method variants model the previous Candid enum contract"
    )]
    #[derive(CandidType, Clone, Copy, Debug, Deserialize, Eq, PartialEq)]
    enum LegacyHttpMethod {
        #[serde(rename = "get")]
        GET,
        #[serde(rename = "post")]
        POST,
        #[serde(rename = "head")]
        HEAD,
    }

    #[test]
    fn http_method_roundtrips_candid_through_dto_path() {
        let bytes = Encode!(&HttpMethod::Get).expect("encode domain http method");
        let legacy = Decode!(&bytes, LegacyHttpMethod).expect("decode legacy http method");

        assert_eq!(legacy, LegacyHttpMethod::GET);

        let legacy_bytes = Encode!(&LegacyHttpMethod::HEAD).expect("encode legacy http method");
        let method = Decode!(&legacy_bytes, HttpMethod).expect("decode domain http method");

        assert_eq!(method, HttpMethod::Head);
    }
}