Skip to content

ason-lab/ason-rs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ason

Crates.io Documentation License: MIT

Rust support for ASON, a schema-driven format for compact structured data with serde-based encoding and decoding.

中文文档

Why ASON

ASON writes schema once and keeps each row positional:

[
  {"id": 1, "name": "Alice", "active": true},
  {"id": 2, "name": "Bob", "active": false}
]
[{id@int,name@str,active@bool}]:(1,Alice,true),(2,Bob,false)

That makes repeated records shorter and easier to transport or feed into models.

Highlights

  • Serde-based text encoding and decoding
  • Current API uses encode / decode, not the older to_string / from_str names
  • Optional typed schema output
  • Pretty text output and binary format
  • Works well for structs, vectors, options, enums, nested data, and entry-list based keyed collections

Install

[dependencies]
ason = "0.1"
serde = { version = "1", features = ["derive"] }

Quick Start

use ason::{decode, encode, encode_typed};
use serde::{Deserialize, Serialize};

#[derive(Debug, Serialize, Deserialize, PartialEq)]
struct User {
    id: i64,
    name: String,
    active: bool,
}

fn main() -> ason::Result<()> {
    let user = User { id: 1, name: "Alice".into(), active: true };

    let text = encode(&user)?;
    let typed = encode_typed(&user)?;
    let decoded: User = decode(&text)?;

    assert_eq!(decoded.id, 1);
    assert_eq!(typed, "{id@int,name@str,active@bool}:(1,Alice,true)");
    Ok(())
}

Encode a vector

let users = vec![
    User { id: 1, name: "Alice".into(), active: true },
    User { id: 2, name: "Bob".into(), active: false },
];

let text = encode(&users)?;
let typed = encode_typed(&users)?;
let decoded: Vec<User> = decode(&text)?;

Pretty and binary output

use ason::{decode_binary, encode_binary, encode_pretty, encode_pretty_typed};

let pretty = encode_pretty(&users)?;
let pretty_typed = encode_pretty_typed(&users)?;
let bin = encode_binary(&users)?;
let decoded: Vec<User> = decode_binary(&bin)?;

Current API

Function Purpose
encode / encode_typed Encode to text
decode Decode from text
encode_pretty / encode_pretty_typed Pretty text output
encode_binary Encode to binary
decode_binary Decode from binary

Run Examples

cargo test
cargo run --example basic
cargo run --example complex
cargo run --example bench

Contributors

Benchmark Snapshot

Run the benchmark example with:

cargo run --example bench --release

The Rust benchmark now uses the same two-line summary style as the Go example:

Flat struct × 1000 (8 fields, vec)
  Serialize:   JSON   411.05ms /   121675 B | ASON   175.25ms (2.3x) /    56718 B (46.6%) | BIN    41.32ms (9.9x) /    74454 B (61.2%)
  Deserialize: JSON   287.06ms | ASON   195.57ms (1.5x) | BIN    64.62ms (4.4x)

ASON / BIN ratios are measured against JSON, and size percentages show the remaining size relative to JSON.

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages