Struct 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) -> Self

where 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.

pub fn with_link<N, L>(self, name: N, link: L) -> Self

where 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>) -> Self

where N: ToString, L: Into<Link>,

Add a new link to a HAL document.

pub fn with_embedded<N, H>(self, name: N, value: H) -> Self

where N: ToString, H: Into<Hal>,

Add a new embedded HAL document to the HAL document.

pub fn maybe_with_embedded<N, L>(self, name: N, embedded: Option<L>) -> Self

where N: ToString, L: Into<Hal>,

Add a new embedded HAL document to a HAL document.

pub fn with_template<N, T>(self, name: N, value: T) -> Self

where 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>) -> Self

where N: ToString, T: Into<Template>,

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

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.