jasn 0.2.0

A Rust library for parsing and formatting JASN (Just Another Serialization Notation)
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

//! Serialization of Rust values to JASN text.

use jasn_core::ser;
use serde::Serialize;

use crate::{Value, formatter};

/// Error type for serialization.
pub type Error = ser::Error;

/// Result type for serialization.
pub type Result<T> = std::result::Result<T, Error>;

/// Serialize a Rust value to a JASN string.
pub fn to_string<T>(value: &T) -> Result<String>
where
    T: Serialize,
{
    let jasn_value = ser::to_value(value)?;
    Ok(formatter::format(&jasn_value))
}

/// Serialize a Rust value to a JASN string with pretty formatting.
pub fn to_string_pretty<T>(value: &T) -> Result<String>
where
    T: Serialize,
{
    let jasn_value = ser::to_value(value)?;
    Ok(formatter::format_pretty(&jasn_value))
}

/// Serialize a Rust value to a JASN string with custom formatting options.
pub fn to_string_opts<T>(value: &T, options: &formatter::Options) -> Result<String>
where
    T: Serialize,
{
    // TODO: optimize by directly serializing to string instead of going through Value
    let jasn_value = ser::to_value(value)?;
    Ok(formatter::format_with_opts(&jasn_value, options))
}

/// Serialize a Rust value to a JASN [`Value`].
pub fn to_value<T>(value: &T) -> Result<Value>
where
    T: Serialize + ?Sized,
{
    ser::to_value(value)
}