noyalib 0.0.5

A pure Rust YAML library with zero unsafe code and full serde integration
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

// SPDX-License-Identifier: MIT OR Apache-2.0
// Copyright (c) 2026 Noyalib. All rights reserved.

//! Zero-copy patterns: minimize allocations during deserialization.
//!
//! noyalib currently materializes a Value AST before deserializing into
//! structs. True zero-copy `&'de str` from the input is planned for v0.0.3.
//!
//! This example demonstrates the patterns available today for reducing
//! allocations: Cow<str>, from_value with references, and Value-as-view.
//!
//! Run: `cargo run --example borrow`

#[path = "support.rs"]
mod support;

use noyalib::{Value, from_str};
use std::borrow::Cow;

fn main() {
    support::header("noyalib -- borrow");

    // ── Value as zero-copy view ──────────────────────────────────────
    support::task_with_output("Value::as_str() borrows from the Value", || {
        let yaml = "name: noyalib\nhost: localhost\npath: /api/v1\n";
        let v: Value = from_str(yaml).unwrap();

        // as_str() returns &str — no allocation, borrows from Value
        let name: &str = v.get("name").and_then(|v| v.as_str()).unwrap();
        let host: &str = v.get("host").and_then(|v| v.as_str()).unwrap();
        let path: &str = v.get("path").and_then(|v| v.as_str()).unwrap();

        vec![
            format!("name = {name} (borrowed &str)"),
            format!("host = {host} (borrowed &str)"),
            format!("path = {path} (borrowed &str)"),
            "0 allocations for field access".to_string(),
        ]
    });

    // ── Cow<str> for conditional ownership ───────────────────────────
    support::task_with_output("Cow<str>: own only when needed", || {
        let yaml = "greeting: hello\n";
        let v: Value = from_str(yaml).unwrap();

        let greeting: Cow<str> = match v.get("greeting").and_then(|v| v.as_str()) {
            Some(s) => Cow::Borrowed(s),
            None => Cow::Owned("default".to_string()),
        };

        let missing: Cow<str> = match v.get("missing").and_then(|v| v.as_str()) {
            Some(s) => Cow::Borrowed(s),
            None => Cow::Owned("fallback".to_string()),
        };

        vec![
            format!(
                "greeting = {greeting} ({})",
                if matches!(greeting, Cow::Borrowed(_)) {
                    "borrowed"
                } else {
                    "owned"
                }
            ),
            format!(
                "missing  = {missing} ({})",
                if matches!(missing, Cow::Borrowed(_)) {
                    "borrowed"
                } else {
                    "owned"
                }
            ),
        ]
    });

    // ── get_path avoids intermediate copies ──────────────────────────
    support::task_with_output("get_path: traverse without copying", || {
        let yaml =
            "server:\n  database:\n    host: db.internal\n    pool:\n      min: 5\n      max: 20\n";
        let v: Value = from_str(yaml).unwrap();

        // Each get_path call returns a reference — no cloning
        let host: &str = v
            .get_path("server.database.host")
            .and_then(|v| v.as_str())
            .unwrap();
        let max: i64 = v
            .get_path("server.database.pool.max")
            .and_then(|v| v.as_i64())
            .unwrap();

        vec![
            format!("host = {host} (4 levels deep, 0 copies)"),
            format!("max  = {max} (5 levels deep, 0 copies)"),
        ]
    });

    // ── Batch processing without per-item allocation ─────────────────
    support::task_with_output("Batch: process 1000 items, borrow all", || {
        let yaml: String = (0..1000)
            .map(|i| format!("- name: item_{i}\n  value: {i}\n"))
            .collect();

        let v: Value = from_str(&yaml).unwrap();
        let seq = v.as_sequence().unwrap();

        // Count items by borrowing — zero per-item allocation
        let total: i64 = seq
            .iter()
            .filter_map(|item| item.get("value").and_then(|v| v.as_i64()))
            .sum();

        vec![
            format!("items = {}", seq.len()),
            format!("sum   = {total}"),
            "0 String allocations during iteration".to_string(),
        ]
    });

    // ── Status: zero-copy roadmap ────────────────────────────────────
    support::task_with_output("Zero-copy status", || {
        vec![
            "Today:   Value::as_str() borrows from parsed AST".to_string(),
            "Today:   get_path() traverses without cloning".to_string(),
            "Today:   Cow<str> for conditional ownership".to_string(),
            "Planned: &'de str from input (v0.0.3, issue #8)".to_string(),
        ]
    });

    support::summary(5);
}