canic-core 0.82.28

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

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::{Decode, Encode};

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

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

    #[test]
    fn http_method_deserializes_canonical_lowercase_labels() {
        assert_http_method_label(HttpMethod::Get, "get");
        assert_http_method_label(HttpMethod::Head, "head");
        assert_http_method_label(HttpMethod::Post, "post");
    }

    fn assert_http_method_label(method: HttpMethod, label: &str) {
        let label_bytes = serde_cbor::to_vec(&label).expect("encode HTTP method label");
        let decoded: HttpMethod =
            serde_cbor::from_slice(&label_bytes).expect("decode HTTP method label");
        assert_eq!(decoded, method);
    }
}