rustic_hal 0.1.0

A rust library for creating Hal representations of resources, based on serde
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# Rustic Hal

A simple library for serializing (and deserializing coming soon) resources following the [HAL Spec](https://tools.ietf.org/html/draft-kelly-json-hal-08)

[![Clippy Linting Result](https://clippy.bashy.io/github/pduval/rustic_hal/master/badge.svg)](https://clippy.bashy.io/github/pduval/rustic_hal/master/log)
[![Build Status](https://travis-ci.org/pduval/rustic_hal.svg)](https://travis-ci.org/pduval/rustic_hal)
[![](http://meritbadge.herokuapp.com/rustic_hal)](https://crates.io/crates/rustic_hal)

## Usage

### On nightly rust

Add the dependency to your Cargo.toml:

```toml

[dependencies]
rustic_hal="0.1.0"
serde="0.8"
serde_json="0.8"
serde_derive="0.8"

```
and to use:

```rust

extern crate rustic_hal;
extern crate serde;
extern crate serde_json;

use rustic_hal::*;
use serde::Serialize;
use serde_json::to_json;

#[derive(Serialize)]
pub struct MyResource {
    pub test: String;
}

let mr = MyResource { test: "Hello, World!".to_string() };
let mut hal_res = HalResource::new(mr);
hal_res.add_link("self", "/api/myresource/0");

println!("json representation: {}", to_json(hal_res));

```
## Documentation

see [https://pduval.github.io/rustic_hal/rustic_hal/](https://pduval.github.io/rustic_hal/rustic_hal/) for the cargo-doc pages.

## Credits

This library is heavily inspired by (read copied from) the [hal-rs](https://github.com/hjr3/hal-rs) library by Herman J. Radtke III.

## Warnings

I have only very recently started learning Rust, so the idiomatic quality of  this code is probably very low.