serdeconv 0.4.1

This crate provides convenient traits and functions for converting between TOML/JSON/MessagePack strings and serializable values.
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

use serde::{Deserialize, Serialize};
use serde_json;
use std::fs::File;
use std::io::{Read, Write};
use std::path::Path;

use {Error, Result};

/// Converts from the JSON file to a value of `T` type.
pub fn from_json_file<T, P>(path: P) -> Result<T>
where
    T: for<'a> Deserialize<'a>,
    P: AsRef<Path>,
{
    let f = track!(File::open(path).map_err(Error::from))?;
    track!(from_json_reader(f))
}

/// Reads a JSON string from the reader and converts it to a value of `T` type.
pub fn from_json_reader<T, R>(reader: R) -> Result<T>
where
    T: for<'a> Deserialize<'a>,
    R: Read,
{
    let value = track!(serde_json::from_reader(reader).map_err(Error::from))?;
    Ok(value)
}

/// Converts from the JSON string to a value of `T` type.
pub fn from_json_str<'a, T>(json: &'a str) -> Result<T>
where
    T: Deserialize<'a>,
{
    let value = track!(serde_json::from_str(json).map_err(Error::from))?;
    Ok(value)
}

/// Converts from the JSON bytes to a value of `T` type.
pub fn from_json_slice<'a, T>(json: &'a [u8]) -> Result<T>
where
    T: Deserialize<'a>,
{
    let value = track!(serde_json::from_slice(json).map_err(Error::from))?;
    Ok(value)
}

/// Converts the value to a JSON string and writes it to the speficied file.
pub fn to_json_file<T, P>(value: &T, path: P) -> Result<()>
where
    T: ?Sized + Serialize,
    P: AsRef<Path>,
{
    let f = track!(File::create(path).map_err(Error::from))?;
    track!(to_json_writer(value, f))
}

/// Converts the value to a JSON string and writes it to the writer.
pub fn to_json_writer<T, W>(value: &T, writer: W) -> Result<()>
where
    T: ?Sized + Serialize,
    W: Write,
{
    track!(serde_json::to_writer(writer, value).map_err(Error::from))?;
    Ok(())
}

/// Converts the value to a pretty printed JSON string and writes it to the writer.
pub fn to_json_writer_pretty<T, W>(value: &T, writer: W) -> Result<()>
where
    T: ?Sized + Serialize,
    W: Write,
{
    track!(serde_json::to_writer_pretty(writer, value).map_err(Error::from,))?;
    Ok(())
}

/// Converts the value to a JSON string.
pub fn to_json_string<T>(value: &T) -> Result<String>
where
    T: ?Sized + Serialize,
{
    let json = track!(serde_json::to_string(value).map_err(Error::from))?;
    Ok(json)
}

/// Converts the value to a pretty printed JSON string.
pub fn to_json_string_pretty<T>(value: &T) -> Result<String>
where
    T: ?Sized + Serialize,
{
    let json = track!(serde_json::to_string_pretty(value).map_err(Error::from))?;
    Ok(json)
}