[−][src]Crate kserd

Kurt's Self Explanatory Rust Data.

See the rs docs. Look at progress and contribute on github.

Introduction

kserd provides a data structure to represent programmatic data (mainly for Rust). Data is held in enum variants covering the basic primitives along with nested structures such as tuples, containers, sequences, and maps. kserd tries to differentiate itself by providing the data structure as the in-memory intermediary between serialized format and a programming language's structure. The serialized format is inspired by TOML to make kserd as human-readable as possible.

Getting Started

With default features enabled, using kserd is a simple as importing the root which will contain all the important items.

use kserd::*;

// Kserd and Value are the building blocks of the data.
let mut kserd = Kserd::with_id("greeting", Value::new_str("Hello")).unwrap();

// Kserd/Value are meant to be useable in their memory form
// not just simple data holding structure!
assert_eq!(kserd.str(), Some("Hello"));

// you can mutate in place as well
kserd.str_mut().map(|s| { s.push_str(", world!"); });
assert_eq!(kserd.str(), Some("Hello, world!"));

// encode data structures that implement serde::Serialize
let kserd = Kserd::enc(&vec![0, 1, 2, 4]).unwrap();

// can format the kserd into a human-readable string
println!("{}", kserd.as_str()); // should print [0, 1, 2, 4]

It is recommended to consult the api documentation as there is extensive examples and explanations.

Features

The kserd library is feature gated, but all features are enabled by default.

Feature	Description	Further reading
encode	Convert data structures to and from `Kserd`. Makes use of `serde` `Serialize` and `Deserialize` traits.	`kserd::encode`
format	Format a `Kserd` to a human-readable string.	`kserd::format`
parse	Parse a string into a `Kserd`.	`kserd::parse`

To `1.0` Stabilistations

[ ] stabilise kserd_derive crate
[ ] extra implementations for ToKserd
[ ] further testing of parsing to catch edge cases

Modules

ds	The data structures, such as `Kserd` and `Value`.
encode	`Encoder` and `Decoder` for converting between data structures and `Kserd`.
fmt	Format a `Kserd` into a human-readable string.
nav	Navigate around a `Kserd`.
parse	Parse a string into a `Kserd`.

Structs

Barr	An owned or borrowed byte array.
Kserd	The atomic value.
Kstr	An owned or borrowed string.

Enums

Number	A numerical value.
ToKserdErr	Errors that can occur when using `ToKserd`.
Value	The value of a `Kserd`.

Traits

ToKserd

Convert something into a Kserd.