Struct HttpUpdateRequest

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

A Candid-encodable representation of an HTTP update request. This struct is used by the http_update_request method of the HTTP Gateway Protocol.

This is the same as HttpRequest, excluding the certificate_version property.

Examples

use ic_http_certification::{HttpUpdateRequest, HttpRequest, Method};

let request = HttpRequest::get("/")
    .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();
let update_request = HttpUpdateRequest::from(request);

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

Implementations

impl<'a> HttpUpdateRequest<'a>

pub fn method(&self) -> &Method

Returns the HTTP method of the request.

Examples

use ic_http_certification::HttpRequest;

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

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_update();

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_update();

assert_eq!(request.headers(), &[("Accept".into(), "text/plain".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_update();

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

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 HttpUpdateRequest<'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 HttpUpdateRequest<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for HttpUpdateRequest<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for HttpUpdateRequest<'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 HttpUpdateRequest<'a>

fn eq(&self, other: &HttpUpdateRequest<'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 HttpUpdateRequest<'a>

impl<'a> StructuralPartialEq for HttpUpdateRequest<'a>