zoon-format 1.0.3

ZOON - Zero Overhead Object Notation encoder/decoder
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

# zoon-rust


A Rust implementation of [ZOON (Zero Overhead Object Notation)](https://github.com/zoon-format/zoon/blob/main/SPEC.md) - the most token-efficient data format for LLMs.

[![Crates.io](https://img.shields.io/crates/v/zoon-format)](https://crates.io/crates/zoon-format)
[![License](https://img.shields.io/badge/License-MIT-green)](LICENSE)

## Installation


Add to your `Cargo.toml`:

```toml
[dependencies]
zoon-format = "1.0"
```

## Usage


### Encoding


```rust
use zoon::encode;
use serde::Serialize;

#[derive(Serialize)]

struct User {
    id: i32,
    name: String,
    role: String,
    active: bool,
}

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

    let encoded = zoon::encode(&users).unwrap();
    println!("{}", encoded);
    // # id:i name:s role=Admin|User active:b
    // Alice Admin 1
    // Bob User 0
}
```

### Decoding


```rust
use zoon::decode;
use serde::Deserialize;

#[derive(Deserialize, Debug)]

struct User {
    id: i32,
    name: String,
    role: String,
    active: bool,
}

fn main() {
    let input = "# id:i name:s role:s active:b\n1 Alice Admin 1\n2 Bob User 0";
    let users: Vec<User> = zoon::decode(input).unwrap();
    println!("{:?}", users);
}
```

## API


| Function                                                | Description                           |
| ------------------------------------------------------- | ------------------------------------- |
| `encode<T: Serialize>(value: &T) -> Result<String>`     | Encode any serializable value to ZOON |
| `decode<T: DeserializeOwned>(input: &str) -> Result<T>` | Decode ZOON into a value              |

## Type Mapping


| Rust Type          | ZOON Type | Header |
| ------------------ | --------- | ------ |
| `i32`, `i64`       | Integer   | `:i`   |
| `bool`             | Boolean   | `:b`   |
| `String`           | String    | `:s`   |
| `Option<T>` (None) | Null      | `~`    |
| Auto-increment ID  | Implicit  | `:i+`  |

## License


MIT License. © 2025-PRESENT Carsen Klock.