Struct oneitfarm_interface_httpserver::HttpResponse

pub struct HttpResponse {
    pub status_code: u16,
    pub header: HeaderMap,
    pub body: Vec<u8>,
}

HttpResponse contains the actor’s response to return to the http client

Fields

status_code: u16

statusCode is a three-digit number, usually in the range 100-599, A value of 200 indicates success.

header: HeaderMap

Map of headers (string keys, list of values)

body: Vec<u8>

Body of response as a byte array. May be an empty array.

Implementations

impl HttpResponse

pub fn json<T>(payload: T, status_code: u16) -> Result<HttpResponse, RpcError>where
    T: Serialize,

Creates a response with a given status code and serializes the given payload as JSON

pub fn json_with_headers<T>(
    payload: T,
    status_code: u16,
    headers: HashMap<String, Vec<String>>
) -> Result<HttpResponse, RpcError>where
    T: Serialize,

Creates a response with a given status code, JSON-serialized payload, and headers specified by the header argument. Automatically includes the appropriate Content-Type header

Arguments

• payload - Any struct implementing the Serialize trait from serde/serde_json
• status_code - A 16-bit unsigned integer representing the outbound HTTP status code, e.g. 200 for successful interactions, 404 for not found, etc..
• headers - A std::collections::HashMap from a String to a Vec() of Strings. The Content-Type header is ignored, for Content-Type will always default to application/json

pub fn not_found() -> HttpResponse

Handy shortcut for creating a 404/Not Found response

pub fn internal_server_error<T: ToString>(msg: T) -> HttpResponse

Useful shortcut for creating a 500/Internal Server Error response

pub fn bad_request<T: ToString>(msg: T) -> HttpResponse

Shortcut for creating a 400/Bad Request response

Trait Implementations

impl Clone for HttpResponse

fn clone(&self) -> HttpResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HttpResponse

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

Formats the value using the given formatter.

impl Default for HttpResponse

fn default() -> HttpResponse

create default HttpResponse with status 200, empty body and empty header

impl<'de> Deserialize<'de> for HttpResponse

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<HttpResponse> for HttpResponse

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for HttpResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for HttpResponse

impl StructuralEq for HttpResponse

impl StructuralPartialEq for HttpResponse