libyml 0.0.6

DEPRECATED — `libyml` is unmaintained. This release is a thin compatibility shim that forwards every call to `unsafe-libyaml` (the upstream C-libyaml translation `libyml` was originally forked from). Please migrate to `unsafe-libyaml`, `yaml-rust2`, or `noyalib`.
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

// SPDX-License-Identifier: MIT OR Apache-2.0
//
// Retained from `libyml ≤ 0.0.5`. This file shows what migration to
// the 0.0.6 shim looks like for a typical downstream test that only
// touches the public surface (`yaml_parser_initialize` /
// `_set_input_string` / `_parse` / `_delete`). Two mechanical
// patches are needed and nothing else:
//
//  1. `is_success(yaml_X(...))` → `is_success(yaml_X(...).ok)` —
//     because the upstream `unsafe-libyaml` returns a `Success`
//     struct whose `Success` type is no longer nameable. Reading
//     `.ok` is the supported access path; the `is_success` helper
//     now takes `bool`.
//
//  2. The `#![no_std]` attribute is dropped because the test crate
//     transitively depends on `std` through the shim's re-export
//     chain. Production callers can still build the library itself
//     under `no_std`.

#![allow(deprecated)]

#[cfg(test)]
mod tests {
    use core::mem::MaybeUninit;
    use libyml::success::is_success;
    use libyml::*;

    /// Tests the initialization and deletion of the YAML parser.
    #[test]
    fn test_parser_initialize_and_delete() {
        unsafe {
            let mut parser = MaybeUninit::<YamlParserT>::uninit();
            assert!(is_success(
                yaml_parser_initialize(parser.as_mut_ptr()).ok
            ));
            let mut parser = parser.assume_init();
            yaml_parser_delete(&mut parser);
        }
    }

    /// Tests setting the input string for the YAML parser.
    #[test]
    fn test_parser_set_input_string() {
        unsafe {
            let mut parser = MaybeUninit::<YamlParserT>::uninit();
            assert!(is_success(
                yaml_parser_initialize(parser.as_mut_ptr()).ok
            ));
            let mut parser = parser.assume_init();

            let input = b"key: value\n";
            yaml_parser_set_input_string(
                &mut parser,
                input.as_ptr(),
                input.len() as u64,
            );

            yaml_parser_delete(&mut parser);
        }
    }

    /// Tests parsing a simple YAML document.
    #[test]
    fn test_parser_parse_simple_document() {
        unsafe {
            let mut parser = MaybeUninit::<YamlParserT>::uninit();
            assert!(is_success(
                yaml_parser_initialize(parser.as_mut_ptr()).ok
            ));
            let mut parser = parser.assume_init();

            let input = b"key: value\n";
            yaml_parser_set_input_string(
                &mut parser,
                input.as_ptr(),
                input.len() as u64,
            );

            let mut event = MaybeUninit::<YamlEventT>::uninit();
            assert!(is_success(
                yaml_parser_parse(&mut parser, event.as_mut_ptr()).ok
            ));
            let _event = event.assume_init();

            yaml_parser_delete(&mut parser);
        }
    }

    /// Tests parsing of a complex YAML document with nested structures.
    #[test]
    fn test_complex_document() {
        unsafe {
            let mut parser = MaybeUninit::<YamlParserT>::uninit();
            assert!(is_success(
                yaml_parser_initialize(parser.as_mut_ptr()).ok
            ));
            let mut parser = parser.assume_init();

            let input = b"
            parent:
                child1: value1
                child2:
                - list_item1
                - list_item2
            ";
            yaml_parser_set_input_string(
                &mut parser,
                input.as_ptr(),
                input.len() as u64,
            );

            let mut event = MaybeUninit::<YamlEventT>::uninit();
            assert!(is_success(
                yaml_parser_parse(&mut parser, event.as_mut_ptr()).ok
            ));
            let _event = event.assume_init();

            yaml_parser_delete(&mut parser);
        }
    }

    /// Tests handling invalid YAML input.
    #[test]
    fn test_parser_handle_invalid_input() {
        unsafe {
            let mut parser = MaybeUninit::<YamlParserT>::uninit();
            assert!(is_success(
                yaml_parser_initialize(parser.as_mut_ptr()).ok
            ));
            let mut parser = parser.assume_init();

            let input = b"invalid_yaml";
            yaml_parser_set_input_string(
                &mut parser,
                input.as_ptr(),
                input.len() as u64,
            );

            let mut event = MaybeUninit::<YamlEventT>::uninit();
            let result =
                yaml_parser_parse(&mut parser, event.as_mut_ptr());

            assert!(is_success(result.ok));

            yaml_parser_delete(&mut parser);
        }
    }
}