Struct ic_cdk::api::management_canister::http_request::CanisterHttpRequestArgument

pub struct CanisterHttpRequestArgument {
    pub url: String,
    pub max_response_bytes: Option<u64>,
    pub method: HttpMethod,
    pub headers: Vec<HttpHeader>,
    pub body: Option<Vec<u8>>,
    pub transform: Option<TransformContext>,
}

Argument type of http_request.

Fields

url: String

The requested URL.

max_response_bytes: Option<u64>

The maximal size of the response in bytes. If None, 2MiB will be the limit.

method: HttpMethod

The method of HTTP request.

headers: Vec<HttpHeader>

List of HTTP request headers and their corresponding values.

body: Option<Vec<u8>>

Optionally provide request body.

transform: Option<TransformContext>

Name of the transform function which is func (transform_args) -> (http_response) query.

Trait Implementations

impl CandidType for CanisterHttpRequestArgument

fn _ty() -> Type

fn id() -> TypeId

fn idl_serialize<__S>(&self, __serializer: __S) -> Result<(), __S::Error>where
    __S: Serializer,

fn ty() -> Type

impl Clone for CanisterHttpRequestArgument

fn clone(&self) -> CanisterHttpRequestArgument

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CanisterHttpRequestArgument

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CanisterHttpRequestArgument

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<CanisterHttpRequestArgument> for CanisterHttpRequestArgument

fn eq(&self, other: &CanisterHttpRequestArgument) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CanisterHttpRequestArgument