Struct HttpRequest

pub struct HttpRequest<'a> { /* private fields */ }

A Candid-encodable representation of an HTTP request. This struct is used by the http_request method of the HTTP Gateway Protocol’s Candid interface.

Examples

use ic_http_certification::{HttpRequest, Method};

let request = HttpRequest::builder()
    .with_method(Method::GET)
    .with_url("/")
    .with_headers(vec![("X-Custom-Foo".into(), "Bar".into())])
    .with_body(&[1, 2, 3])
    .with_certificate_version(2)
    .build();

assert_eq!(request.method(), Method::GET);
assert_eq!(request.url(), "/");
assert_eq!(request.headers(), &[("X-Custom-Foo".into(), "Bar".into())]);
assert_eq!(request.body(), &[1, 2, 3]);
assert_eq!(request.certificate_version(), Some(2));

Helpers

There are also a number of convenience methods for quickly creating an HttpRequest with commonly used HTTP methods:

• GET
• POST
• PUT
• PATCH
• DELETE

use ic_http_certification::HttpRequest;

let request = HttpRequest::get("/").build();

assert_eq!(request.method(), "GET");
assert_eq!(request.url(), "/");

Implementations

impl<'a> HttpRequest<'a>

pub fn get(url: impl Into<String>) -> HttpRequestBuilder<'a>

Creates a new HttpRequestBuilder initialized with a GET method and the given URL.

This method returns an instance of HttpRequestBuilder which can be used to create an HttpRequest.

Examples

use ic_http_certification::{HttpRequest, Method};

let request = HttpRequest::get("/").build();

assert_eq!(request.method(), Method::GET);

pub fn post(url: impl Into<String>) -> HttpRequestBuilder<'a>

Creates a new HttpRequestBuilder initialized with a POST method and the given URL.

This method returns an instance of HttpRequestBuilder which can be used to create an HttpRequest.

Examples

use ic_http_certification::{HttpRequest, Method};

let request = HttpRequest::post("/").build();

assert_eq!(request.method(), Method::POST);

pub fn put(url: impl Into<String>) -> HttpRequestBuilder<'a>

Creates a new HttpRequestBuilder initialized with a PUT method and the given URL.

This method returns an instance of HttpRequestBuilder which can be used to create an HttpRequest.

Examples

use ic_http_certification::{HttpRequest, Method};

let request = HttpRequest::put("/").build();

assert_eq!(request.method(), Method::PUT);

pub fn patch(url: impl Into<String>) -> HttpRequestBuilder<'a>

Creates a new HttpRequestBuilder initialized with a PATCH method and the given URL.

This method returns an instance of HttpRequestBuilder which can be used to create an HttpRequest.

Examples

use ic_http_certification::{HttpRequest, Method};

let request = HttpRequest::patch("/").build();

assert_eq!(request.method(), Method::PATCH);

pub fn delete(url: impl Into<String>) -> HttpRequestBuilder<'a>

Creates a new HttpRequestBuilder initialized with a DELETE method and the given URL.

This method returns an instance of HttpRequestBuilder which can be used to create an HttpRequest.

Examples

use ic_http_certification::{HttpRequest, Method};

let request = HttpRequest::delete("/").build();

assert_eq!(request.method(), Method::DELETE);

pub fn builder() -> HttpRequestBuilder<'a>

Creates and returns an instance of HttpRequestBuilder, a builder-style object which can be used to create an HttpRequest.

Examples

use ic_http_certification::{HttpRequest, Method};

let request = HttpRequest::builder()
    .with_method(Method::GET)
    .with_url("/")
    .with_headers(vec![("X-Custom-Foo".into(), "Bar".into())])
    .with_body(&[1, 2, 3])
    .with_certificate_version(2)
    .build();

assert_eq!(request.method(), Method::GET);
assert_eq!(request.url(), "/");
assert_eq!(request.headers(), &[("X-Custom-Foo".into(), "Bar".into())]);
assert_eq!(request.body(), &[1, 2, 3]);
assert_eq!(request.certificate_version(), Some(2));

pub fn method(&self) -> &Method

Returns the HTTP method of the request.

Examples

use ic_http_certification::HttpRequest;

let request = HttpRequest::get("/").build();

assert_eq!(request.method(), "GET");

pub fn url(&self) -> &str

Returns the URL of the request.

Examples

use ic_http_certification::HttpRequest;

let request = HttpRequest::get("/").build();

assert_eq!(request.url(), "/");

pub fn headers(&self) -> &[HeaderField]

Returns the headers of the request.

Examples

use ic_http_certification::HttpRequest;

let request = HttpRequest::get("/")
    .with_headers(vec![("Accept".into(), "text/plain".into())])
    .build();

assert_eq!(request.headers(), &[("Accept".into(), "text/plain".into())]);

pub fn headers_mut(&mut self) -> &mut Vec<HeaderField>

Returns a mutable reference to the HTTP headers of the request.

Examples

use ic_http_certification::HttpRequest;

let mut request = HttpRequest::get("/")
    .with_headers(vec![("Content-Type".into(), "text/plain".into())])
    .build();

request.headers_mut().push(("Content-Length".into(), "13".into()));

assert_eq!(request.headers(), &[("Content-Type".into(), "text/plain".into()), ("Content-Length".into(), "13".into())]);

pub fn body(&self) -> &[u8]

Returns the body of the request.

Examples

use ic_http_certification::HttpRequest;

let request = HttpRequest::get("/")
    .with_body(&[1, 2, 3])
    .build();

assert_eq!(request.body(), &[1, 2, 3]);

pub fn certificate_version(&self) -> Option<u16>

Returns the max response verification version to use in the response’s certificate.

Examples

use ic_http_certification::HttpRequest;

let request = HttpRequest::get("/")
    .with_certificate_version(2)
    .build();

assert_eq!(request.certificate_version(), Some(2));

pub fn get_path(&self) -> HttpCertificationResult<String>

Returns the path of the request URL, without domain, query parameters or fragments.

Examples

use ic_http_certification::HttpRequest;

let request = HttpRequest::get("https://canister.com/sample-asset.txt").build();

assert_eq!(request.get_path().unwrap(), "/sample-asset.txt");

pub fn get_query(&self) -> HttpCertificationResult<Option<String>>

Returns the query parameters of the request URL, if any, as a string.

Examples

use ic_http_certification::HttpRequest;

let request = HttpRequest::get("https://canister.com/sample-asset.txt?foo=bar").build();

assert_eq!(request.get_query().unwrap(), Some("foo=bar".to_string()));

Trait Implementations

impl<'a> CandidType for HttpRequest<'a>

fn _ty() -> Type

fn id() -> TypeId

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

where __S: Serializer,

fn ty() -> Type

impl<'a> Clone for HttpRequest<'a>

fn clone(&self) -> HttpRequest<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for HttpRequest<'a>

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<HttpRequest<'a>> for HttpUpdateRequest<'a>

fn from(req: HttpRequest<'a>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for HttpRequest<'a>

fn eq(&self, other: &HttpRequest<'a>) -> 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<'a> Eq for HttpRequest<'a>

impl<'a> StructuralPartialEq for HttpRequest<'a>