Stellar Notation Rust

The Rust Implementation of Stellar Notation, a serialization library of a data interchange format for transmission and storage.

Usage

stellar-notation = "0.9.3"

use stellar_notation::{
    StellarObject, StellarValue,
    serialize_stellar_object, deserialize_stellar_object,
    serialize_stellar_objects, deserialize_stellar_objects
}

Object

An Object is a Key-Value Tuple. Keys are UTF-8 String and Values can be a UTF-8 String, Unsigned Integer and Bytes.

Value Types

Object Creation

let key: String = String::from("key_1");
let value: StellarValue = StellarValue::StringType(String::from("value_1"));
let object: StellarObject = StellarObject(key, value);

Object Serialization

Converts a StellarObject into bytes.

let serialized: Vec<u8> = serialize_stellar_object(object);

Serialized Object Structure

Value data is also limited by the system file size limit.

Object Deserialization

Reconverts bytes into a StellarObject

let object: StellarObject = deserialize_stellar_object(serialized);

Objects

Objects Serialization

Converts a collection of StellarObjects into bytes.

let objects: Vec<StellarObject> = vec![
    object1, object2, object3
]

let serialized_objects: Vec<u8> = serialize_stellar_objects(objects);

Serialized Objects Structure

Objects Deserialization

Reconverts bytes into a collection of StellarObjects.

let objects: Vec<StellarObject> = deserialize_stellar_objects(serialized_objects);

Future Topics

• Signed Integers
• Floating Point Numbers
• Boolean