hal-rs

A pure rust library for generating Hal responses.

Builds

Running the tests:

$ cargo test

Examples

See hal-rs-demo for actual working example.

A sample program that shows how to create a Hal response manually or by implementing ToHal on your struct.

```rust extern crate hal; extern crate serialize;

use hal::{Link, Resource, ToHal, ToHalData}; use serialize::json::ToJson;

struct Order { total: f64, currency: String, status: String }

impl ToHal for Order { fn tohal(self) -> Resource { Resource::withself("https://www.example.com/orders/1") .addstate("total", self.total) .addstate("currency", self.currency) .add_state("status", self.status) } }

fn main() { let hal = Resource::withself("/orders") .addcurie("ea", "http://example.com/docs/rels/{rel}") .addlink("next", Link::new("/orders?page=2")) .addlink("ea:find", Link::new("/orders{?id}").templated(true)) .addlink("ea:admin", Link::new("/admins/2").title("Fred")) .addlink("ea:admin", Link::new("/admins/5").title("Kate")) .addstate("currentlyProcessing", 14) .addstate("shippedToday", 14) .addresource("ea:order", Resource::withself("/orders/123") .addlink("ea:basket", Link::new("/baskets/98712")) .addlink("ea:customer", Link::new("/customers/7809")) .addstate("total", (30.00 as f64)) .addstate("currency", "USD") .addstate("status", "shipped") ) .addresource("ea:order", Resource::withself("/orders/124") .addlink("ea:basket", Link::new("/baskets/97213")) .addlink("ea:customer", Link::new("/customers/12369")) .addstate("total", (20.00 as f64)) .addstate("currency", "USD") .addstate("status", "processing") );

println!("Creating Hal using a DSL: {}", hal.to_json().to_pretty_str());

let order = Order { total: 20.00 as f64, 
                    currency: String::from_str("USD"), 
                    status: String::from_str("processing") };

println!("Creating Hal using to_hal(): {}", order.to_hal().to_json().to_pretty_str());

} ```