Struct HttpUpdateResponse

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

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

This is the same as HttpResponse, excluding the upgrade field.

Examples

use ic_http_certification::{HttpResponse, HttpUpdateResponse, StatusCode};

let response = HttpResponse::builder()
    .with_status_code(StatusCode::OK)
    .with_headers(vec![("Content-Type".into(), "text/plain".into())])
    .with_body(b"Hello, World!")
    .build_update();

let update_response = HttpUpdateResponse::from(response);

assert_eq!(update_response.status_code(), StatusCode::OK);
assert_eq!(update_response.headers(), &[("Content-Type".into(), "text/plain".into())]);
assert_eq!(update_response.body(), b"Hello, World!");

Implementations

impl<'a> HttpUpdateResponse<'a>

pub fn status_code(&self) -> StatusCode

Returns the HTTP status code of the response.

Examples

use ic_http_certification::{HttpResponse, StatusCode};

let response = HttpResponse::builder()
    .with_status_code(StatusCode::OK)
    .build_update();

assert_eq!(response.status_code(), StatusCode::OK);

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

Returns the HTTP headers of the response.

Examples

use ic_http_certification::HttpResponse;

let response = HttpResponse::builder()
    .with_headers(vec![("Content-Type".into(), "text/plain".into())])
    .build_update();

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

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

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

Examples

use ic_http_certification::HttpResponse;

let mut response = HttpResponse::builder()
    .with_headers(vec![("Content-Type".into(), "text/plain".into())])
    .build_update();

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

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

pub fn add_header(&mut self, header: HeaderField)

Adds an additional header to the HTTP response.

Examples

use ic_http_certification::HttpResponse;

let mut response = HttpResponse::builder()
    .with_headers(vec![("Content-Type".into(), "text/plain".into())])
    .build_update();

response.add_header(("Content-Length".into(), "13".into()));

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

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

Returns the HTTP body of the response.

Examples

use ic_http_certification::HttpResponse;

let response = HttpResponse::builder()
    .with_body(b"Hello, World!")
    .build_update();

assert_eq!(response.body(), b"Hello, World!");

Trait Implementations

impl<'a> CandidType for HttpUpdateResponse<'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 HttpUpdateResponse<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for HttpUpdateResponse<'a>

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

Formats the value using the given formatter.

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

fn from(response: HttpResponse<'a>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for HttpUpdateResponse<'a>

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

impl<'a> StructuralPartialEq for HttpUpdateResponse<'a>