Struct http_halforms::Hal

pub struct Hal {
    pub links: BTreeMap<String, SingleOrMultiple<Link>>,
    pub embedded: BTreeMap<String, SingleOrMultiple<Hal>>,
    pub templates: BTreeMap<String, Template>,
    pub payload: Value,
}

Representation of a HAL document.

Fields

links: BTreeMap<String, SingleOrMultiple<Link>>

embedded: BTreeMap<String, SingleOrMultiple<Hal>>

templates: BTreeMap<String, Template>

payload: Value

Implementations

impl Hal

pub fn new<V>(value: V) -> Selfwhere
    V: Serialize,

Create a new HAL document for the given payload value.

Panics

This will panic if the value provided can not be serialized into JSON for some reason.

Examples found in repository

src/response.rs (line 138)

pub fn new<V>(value: V) -> HalResponse
where
    V: Serialize,
{
    HalResponse {
        hal:         Hal::new(value),
        status_code: StatusCode::OK,
        headers:     HeaderMap::default(),
    }
}

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.

Examples found in repository

src/response.rs (line 23)

    pub fn with_link<N, L>(mut self, name: N, link: L) -> Self
    where
        N: ToString,
        L: Into<Link>,
    {
        self.hal = self.hal.with_link(name, link);

        self
    }

src/hal/hal.rs (line 75)

    pub fn maybe_with_link<N, L>(self, name: N, link: Option<L>) -> Self
    where
        N: ToString,
        L: Into<Link>,
    {
        if let Some(link) = link {
            self.with_link(name, link)
        } else {
            self
        }
    }

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.

Examples found in repository

src/response.rs (line 35)

    pub fn maybe_with_link<N, L>(mut self, name: N, link: Option<L>) -> Self
    where
        N: ToString,
        L: Into<Link>,
    {
        self.hal = self.hal.maybe_with_link(name, link);

        self
    }

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.

Examples found in repository

src/response.rs (line 47)

    pub fn with_embedded<N, H>(mut self, name: N, value: H) -> Self
    where
        N: ToString,
        H: Into<Hal>,
    {
        self.hal = self.hal.with_embedded(name, value);

        self
    }

src/hal/hal.rs (line 109)

    pub fn maybe_with_embedded<N, L>(self, name: N, embedded: Option<L>) -> Self
    where
        N: ToString,
        L: Into<Hal>,
    {
        if let Some(embedded) = embedded {
            self.with_embedded(name, embedded)
        } else {
            self
        }
    }

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

Add a new embedded HAL document to a HAL document.

Examples found in repository

src/response.rs (line 59)

    pub fn maybe_with_embedded<N, H>(mut self, name: N, value: Option<H>) -> Self
    where
        N: ToString,
        H: Into<Hal>,
    {
        self.hal = self.hal.maybe_with_embedded(name, value);

        self
    }

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.

Examples found in repository

src/response.rs (line 71)

    pub fn with_template<N, T>(mut self, name: N, value: T) -> Self
    where
        N: ToString,
        T: Into<Template>,
    {
        self.hal = self.hal.with_template(name, value);

        self
    }

src/hal/hal.rs (line 135)

    pub fn maybe_with_template<N, T>(self, name: N, template: Option<T>) -> Self
    where
        N: ToString,
        T: Into<Template>,
    {
        if let Some(template) = template {
            self.with_template(name, template)
        } else {
            self
        }
    }

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.

Examples found in repository

src/response.rs (line 83)

    pub fn maybe_with_template<N, T>(mut self, name: N, template: Option<T>) -> Self
    where
        N: ToString,
        T: Into<Template>,
    {
        self.hal = self.hal.maybe_with_template(name, template);

        self
    }

Trait Implementations

impl Debug for Hal

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

Formats the value using the given formatter.

impl Serialize for Hal

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

Serialize this value into the given Serde serializer.