oci-spec 0.2.6

OCI(Open Container Initiative) Runtime-Spec and Image-Spec for Rust
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

# oci-spec
[![oci-spec at crates.io](https://img.shields.io/crates/v/oci-spec.svg)](https://crates.io/crates/oci-spec)
[![oci-spec at docs.rs](https://docs.rs/oci-spec/badge.svg)](https://docs.rs/oci-spec)

oci-spec is a library for Serialize/Deserialize [oci-runtime-spec](https://github.com/opencontainers/runtime-spec) and [oci-image-spec](https://github.com/opencontainers/image-spec) config.

# Usage
## Deserialize oci-runtime-spec
Use `load` of `Spec` to deserialize oci-runtime-spec config.

If it is a required item in oci-runtime-spec but there is no value in JSON, an error will occur.
Also, if there is no JSON value in the optional item in oci-runtime-spec, None will be set.

For example, `ociVersion` is a required item in oci-runtime-spec, but if `ociVersion` does not exist in JSON, an error occurs.

Although `root` is an object type and internally has a required `path`, no error occurs even if there is no value in JSON.
However, if `root` has a value in JSON and the value of the required item held internally is not in JSON, an error occurs.

```
extern crate oci_spec;

use oci_spec::runtime::Spec;

fn main() {
    // Deserialize oci runtime specification config.
    let spec = match Spec::load("config.json") {
        Ok(s) => s,
        Err(e) => panic!("{}", e),
    }
    println!("oci-runtime-spec version is {}", spec.version);
}
```

## Serialize oci-runtime-spec
Use `save` of `Spec` to serialize oci runtime spec config.

If the type is Option and the value is None, it is not serialized.

```
extern crate oci_spec;

use oci_spec::runtime::Spec;

fn main() {
    // Deserialize oci runtime specification config.
    let spec = match Spec::load("config.json") {
        Ok(s) => s,
        Err(e) => panic!("{}", e),
    }
    println!("oci-runtime-spec version is {}", spec.version);
    
    // Serialize oci runtime specification config.
    match Spec::save(&spec, "config.json") {
        Ok(_) => {},
        Err(e) => panic!("{}", e),
    }
}
```

# License
oci-spec is under the MIT or Apache-2.0 license.