Struct http_halforms::HalResponse

pub struct HalResponse {
    pub hal: Hal,
    pub status_code: StatusCode,
    pub headers: HeaderMap,
}

Representation of a HAL or HAL-FORMS response that can be returned to a client.

Fields

hal: Hal

status_code: StatusCode

headers: HeaderMap

Implementations

impl HalResponse

pub fn with_link<N, L>(self, name: N, link: L) -> Selfwhere
    N: ToString,
    L: Into<Link>,

Add a new link to a HAL document.

pub fn maybe_with_link<N, L>(self, name: N, link: Option<L>) -> Selfwhere
    N: ToString,
    L: Into<Link>,

Add a new link to a HAL document.

pub fn with_embedded<N, H>(self, name: N, value: H) -> Selfwhere
    N: ToString,
    H: Into<Hal>,

Add a new embedded HAL document to the HAL document.

pub fn maybe_with_embedded<N, H>(self, name: N, value: Option<H>) -> Selfwhere
    N: ToString,
    H: Into<Hal>,

Add a new embedded HAL document to the HAL document.

pub fn with_template<N, T>(self, name: N, value: T) -> Selfwhere
    N: ToString,
    T: Into<Template>,

Add a new action template to the HAL-FORMS document.

pub fn maybe_with_template<N, T>(self, name: N, template: Option<T>) -> Selfwhere
    N: ToString,
    T: Into<Template>,

Add a new action template to the HAL-FORMS document.

pub fn with_status_code<S>(self, status_code: S) -> Selfwhere
    S: Into<StatusCode>,

Specify the status code of the HTTP response.

pub fn with_header<H>(self, header: H) -> Selfwhere
    H: Header,

Specify an HTTP Header to include in the response.

Parameters

• header - The header to include.

Trait Implementations

impl Deref for HalResponse

type Target = Hal

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.