Struct HttpRequest 

pub struct HttpRequest {
    pub method: String,
    pub url: String,
    pub headers: Vec<(String, String)>,
    pub body: ByteBuf,
}

Represents an HTTP request.

This struct is used to encapsulate the details of an HTTP request, including the HTTP method, URL, headers, and body.

Fields

method: String

The HTTP method (e.g., “GET”, “POST”).

url: String

The URL of the request.

headers: Vec<(String, String)>

A list of headers, where each header is represented as a key-value pair.

body: ByteBuf

The body of the request, represented as a byte buffer.

Implementations

impl HttpRequest

pub fn path(&self) -> &str

Extracts the path from the URL.

If the URL contains a query string, the path is the portion before the ?. If no query string is present, the entire URL is returned.

Examples

use ic_http_types::{HttpRequest};
use serde_bytes::ByteBuf;

let request = HttpRequest {
    method: "GET".to_string(),
    url: "/path/to/resource?query=1".to_string(),
    headers: vec![],
    body: ByteBuf::default(),
};
assert_eq!(request.path(), "/path/to/resource");

pub fn raw_query_param(&self, param: &str) -> Option<&str>

Searches for the first appearance of a parameter in the request URL.

Returns None if the given parameter does not appear in the query string.

Parameters

• param: The name of the query parameter to search for.

Examples

use ic_http_types::{HttpRequest};
use serde_bytes::ByteBuf;

let request = HttpRequest {
    method: "GET".to_string(),
    url: "/path?key=value".to_string(),
    headers: vec![],
    body: ByteBuf::default(),
};
assert_eq!(request.raw_query_param("key"), Some("value"));

Trait Implementations

impl CandidType for HttpRequest

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 HttpRequest

fn clone(&self) -> HttpRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HttpRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.