Struct EncodeOptions 

pub struct EncodeOptions {
    pub delimiter: Delimiter,
    pub length_marker: Option<char>,
    pub indent: Indent,
}

Options for encoding JSON values to TOON format.

Fields

delimiter: Delimiter

length_marker: Option<char>

indent: Indent

Implementations

impl EncodeOptions

pub fn new() -> Self

Create new encoding options with defaults.

Examples found in repository

examples/parts/length_marker.rs (line 16)

pub fn length_marker() {
    let data = json!({
        "tags": ["reading", "gaming", "coding"],
        "items": [
            {"sku": "A1", "qty": 2, "price": 9.99},
            {"sku": "B2", "qty": 1, "price": 14.5}
        ]
    });

    let out = encode(&data, &EncodeOptions::new().with_length_marker('#')).unwrap();
    println!("{out}");
}

examples/parts/delimiters.rs (line 17)

pub fn delimiters() {
    let data = json!({
        "items": [
            {"sku": "A1", "name": "Widget", "qty": 2, "price": 9.99},
            {"sku": "B2", "name": "Gadget", "qty": 1, "price": 14.5}
        ]
    });

    // Tab delimiter (\t)
    let tab = encode(&data, &EncodeOptions::new().with_delimiter(Delimiter::Tab)).unwrap();
    println!("{tab}");

    // Pipe delimiter (|)
    let pipe = encode(&data, &EncodeOptions::new().with_delimiter(Delimiter::Pipe)).unwrap();
    println!("\n{pipe}");
}

pub fn with_delimiter(self, delimiter: Delimiter) -> Self

Set the delimiter for array elements.

Examples found in repository

examples/parts/delimiters.rs (line 17)

pub fn delimiters() {
    let data = json!({
        "items": [
            {"sku": "A1", "name": "Widget", "qty": 2, "price": 9.99},
            {"sku": "B2", "name": "Gadget", "qty": 1, "price": 14.5}
        ]
    });

    // Tab delimiter (\t)
    let tab = encode(&data, &EncodeOptions::new().with_delimiter(Delimiter::Tab)).unwrap();
    println!("{tab}");

    // Pipe delimiter (|)
    let pipe = encode(&data, &EncodeOptions::new().with_delimiter(Delimiter::Pipe)).unwrap();
    println!("\n{pipe}");
}

pub fn with_length_marker(self, marker: char) -> Self

Set a character prefix for array length markers (e.g., # for [#3]).

Examples found in repository

examples/parts/length_marker.rs (line 16)

pub fn length_marker() {
    let data = json!({
        "tags": ["reading", "gaming", "coding"],
        "items": [
            {"sku": "A1", "qty": 2, "price": 9.99},
            {"sku": "B2", "qty": 1, "price": 14.5}
        ]
    });

    let out = encode(&data, &EncodeOptions::new().with_length_marker('#')).unwrap();
    println!("{out}");
}

pub fn with_indent(self, style: Indent) -> Self

Set the indentation string for nested structures.

pub fn format_length(&self, length: usize) -> String

Format an array length with optional marker prefix.

pub fn with_spaces(self, count: usize) -> Self

Set indentation to a specific number of spaces.

pub fn with_tabs(self) -> Self

Set indentation to tabs.

Trait Implementations

impl Clone for EncodeOptions

fn clone(&self) -> EncodeOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EncodeOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EncodeOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for EncodeOptions

fn eq(&self, other: &EncodeOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for EncodeOptions

impl StructuralPartialEq for EncodeOptions