Crate serdeconv

Source
Expand description

This crate provides convenient traits and functions for converting between TOML/JSON/MessagePack strings and serializable values.

This is highly depends on the serde crate.

§Examples

Converts from a TOML string to a serializable value:

extern crate serde;
#[macro_use]
extern crate serde_derive;
extern crate serdeconv;

use serdeconv::FromToml;

// Defines a deserializable struct.
#[derive(Deserialize)]
struct Foo {
    bar: String,
    baz: usize
}
impl FromToml for Foo {}

// Converts from the TOML string to a `Foo` value.
let toml = r#"
bar = "aaa"
baz = 123
"#;
let foo = Foo::from_toml_str(toml).unwrap();
assert_eq!(foo.bar, "aaa");
assert_eq!(foo.baz, 123);

Structs§

Error
The error type for this crate.

Enums§

ErrorKind
A list of error kinds.

Traits§

FromJson
This trait allows to convert JSON objects to deserializable values.
FromMsgPack
This trait allows to convert MessagePack binaries to deserializable values.
FromToml
This trait allows to convert TOML objects to deserializable values.
ToJson
This trait allows to convert serializable values to JSON objects.
ToMsgPack
This trait allows to convert serializable values to MessagePack binaries.
ToToml
This trait allows to convert serializable values to TOML objects.

Functions§

from_json_file
Converts from the JSON file to a value of T type.
from_json_reader
Reads a JSON string from the reader and converts it to a value of T type.
from_json_slice
Converts from the JSON bytes to a value of T type.
from_json_str
Converts from the JSON string to a value of T type.
from_msgpack_file
Converts from the MessagePack file to a value of T type.
from_msgpack_reader
Reads a MessagePack bytes from the reader and converts it to a value of T type.
from_msgpack_slice
Converts from the MessagePack bytes to a value of T type.
from_toml_file
Converts from the TOML file to a value of T type.
from_toml_reader
Reads a TOML string from the reader and converts it to a value of T type.
from_toml_slice
Converts from the TOML bytes to a value of T type.
from_toml_str
Converts from the TOML string to a value of T type.
to_json_file
Converts the value to a JSON string and writes it to the speficied file.
to_json_string
Converts the value to a JSON string.
to_json_string_pretty
Converts the value to a pretty printed JSON string.
to_json_writer
Converts the value to a JSON string and writes it to the writer.
to_json_writer_pretty
Converts the value to a pretty printed JSON string and writes it to the writer.
to_msgpack_file
Converts the value to a MessagePack bytes and writes it to the speficied file.
to_msgpack_vec
Converts the value to a MessagePack bytes.
to_msgpack_writer
Converts the value to a MessagePack bytes and writes it to the writer.
to_toml_file
Converts the value to a TOML string and writes it to the speficied file.
to_toml_string
Converts the value to a TOML string.
to_toml_writer
Converts the value to a TOML string and writes it to the writer.

Type Aliases§

Result
A specialized Result type for this crate.