Struct HttpRequestArgs 

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 transform: Option<TransformContext>,
    pub is_replicated: Option<bool>,
}

HTTP Request Args

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, 2MB will be the limit. This value affects the cost of the http request and it is highly recommended to set it as low as possible to avoid unnecessary extra costs.

See also the pricing section of HTTP outcalls documentation.

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.

is_replicated: Option<bool>

If Some(false), the HTTP request will be made by single replica instead of all nodes in the subnet.

Trait Implementations

impl CandidType for HttpRequestArgs

fn _ty() -> Type

fn id() -> TypeId

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

where __S: Serializer,

fn ty() -> Type

impl Clone for HttpRequestArgs

fn clone(&self) -> HttpRequestArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpRequestArgs

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

Formats the value using the given formatter.

impl Default for HttpRequestArgs

fn default() -> HttpRequestArgs

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HttpRequestArgs

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HttpRequestArgs

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for HttpRequestArgs

impl StructuralPartialEq for HttpRequestArgs