Quick Start
Get started with ToonNet in 5 minutes. This guide will walk you through your first TOON serialization.
Step 1: Install ToonNet
dotnet add package ToonNet.Core
Step 2: Create a Model
Create a simple C# class:
public class Person
{
public string Name { get; set; } = "";
public int Age { get; set; }
public string Email { get; set; } = "";
}
Step 3: Serialize to TOON
Use ToonSerializer to convert your object to TOON format:
using ToonNet.Core.Serialization;
var person = new Person
{
Name = "Alice Smith",
Age = 30,
Email = "alice@example.com"
};
string toonString = ToonSerializer.Serialize(person);
Console.WriteLine(toonString);
Output:
Name: Alice Smith
Age: 30
Email: alice@example.com
Step 4: Deserialize from TOON
Convert the TOON string back to your object:
string toonInput = """
Name: Bob Johnson
Age: 25
Email: bob@example.com
""";
Person restoredPerson = ToonSerializer.Deserialize<Person>(toonInput)!;
Console.WriteLine($"{restoredPerson.Name} is {restoredPerson.Age} years old");
// Output: Bob Johnson is 25 years old
Complete Example
Here's a complete working example:
using ToonNet.Core.Serialization;
// Define your model
public class Person
{
public string Name { get; set; } = "";
public int Age { get; set; }
public string Email { get; set; } = "";
}
class Program
{
static void Main()
{
// Create an object
var person = new Person
{
Name = "Alice Smith",
Age = 30,
Email = "alice@example.com"
};
// Serialize to TOON
string toon = ToonSerializer.Serialize(person);
Console.WriteLine("Serialized:");
Console.WriteLine(toon);
// Deserialize back to object
var restored = ToonSerializer.Deserialize<Person>(toon);
Console.WriteLine($"\nDeserialized: {restored.Name}, {restored.Age}");
}
}
TOON vs JSON Comparison
For the same data, compare the output formats:
TOON Format (50 characters):
Name: Alice Smith
Age: 30
Email: alice@example.com
JSON Format (72 characters, indented):
{
"Name": "Alice Smith",
"Age": 30,
"Email": "alice@example.com"
}
TOON drops the braces and most quotes. The savings grow with uniform arrays of objects, which TOON writes as
a table with the field names stated once (items[2]{id,name}:). Measure token counts with your own data and
tokenizer.
What Makes TOON Different?
- Human-Readable: Indentation instead of braces; strings are quoted only when required
- Compact: Tabular arrays state field names once, which usually means fewer tokens than JSON for LLM prompts
- Type-Safe: Strongly typed serialization/deserialization
- Performance: Property access goes through compiled accessors, typed delegates and expression trees (type metadata is read once via reflection and cached); the optional source generator avoids that metadata path
Next Steps
Now that you've completed your first serialization:
- Basic Serialization: Learn more about serializing different types
- Core Features: Explore all serialization options
- Configuration: Customize serialization behavior