rust-yaml 0.0.5

A fast, safe YAML 1.2 library for Rust
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
//! Async streaming YAML parser for non-blocking I/O
//!
//! This module provides async/await support for streaming YAML parsing,
//! enabling efficient processing of YAML from async sources like network
//! streams, async file I/O, and more.

#[cfg(feature = "async")]
use futures::stream::Stream;
#[cfg(feature = "async")]
use std::pin::Pin;
#[cfg(feature = "async")]
use std::task::{Context, Poll};
#[cfg(feature = "async")]
use tokio::io::{AsyncBufRead, AsyncBufReadExt, BufReader};

use crate::{
    parser::{Event, EventType},
    Limits, Position, Result,
};
use std::collections::VecDeque;

/// Async streaming YAML parser
#[cfg(feature = "async")]
pub struct AsyncStreamingParser<R: AsyncBufRead + Unpin> {
    /// Async reader
    reader: R,
    /// Buffer for incomplete data
    buffer: String,
    /// Event queue
    events: VecDeque<Event>,
    /// Current position
    position: Position,
    /// Parse state
    state: AsyncParseState,
    /// Resource limits
    limits: Limits,
    /// Statistics
    stats: AsyncStreamStats,
}

#[cfg(feature = "async")]
#[derive(Debug, Clone, PartialEq)]
enum AsyncParseState {
    Initial,
    InDocument,
    BetweenDocuments,
    Complete,
}

#[cfg(feature = "async")]
#[derive(Debug, Clone, Default)]
/// Statistics for async streaming parser
#[allow(missing_docs)]
pub struct AsyncStreamStats {
    pub bytes_read: usize,
    pub events_generated: usize,
    pub documents_parsed: usize,
}

#[cfg(feature = "async")]
impl<R: AsyncBufRead + Unpin> AsyncStreamingParser<R> {
    /// Create a new async streaming parser
    pub fn new(reader: R, limits: Limits) -> Self {
        Self {
            reader,
            buffer: String::with_capacity(4096),
            events: VecDeque::with_capacity(100),
            position: Position::new(),
            state: AsyncParseState::Initial,
            limits,
            stats: AsyncStreamStats::default(),
        }
    }

    /// Parse the next chunk asynchronously
    pub async fn parse_next(&mut self) -> Result<bool> {
        // Read next line or chunk
        let mut line = String::new();
        let bytes_read = self.reader.read_line(&mut line).await?;

        if bytes_read == 0 && self.buffer.is_empty() {
            self.state = AsyncParseState::Complete;
            return Ok(false);
        }

        self.buffer.push_str(&line);
        self.stats.bytes_read += bytes_read;

        // Parse the buffer
        self.parse_buffer()?;

        Ok(!self.events.is_empty())
    }

    /// Parse current buffer content
    fn parse_buffer(&mut self) -> Result<()> {
        match self.state {
            AsyncParseState::Initial => {
                self.emit_event(EventType::StreamStart)?;
                self.state = AsyncParseState::BetweenDocuments;
            }
            AsyncParseState::BetweenDocuments => {
                if self.buffer.contains("---") {
                    self.emit_event(EventType::DocumentStart {
                        version: None,
                        tags: Vec::new(),
                        implicit: true,
                    })?;
                    self.state = AsyncParseState::InDocument;
                    self.stats.documents_parsed += 1;
                }
            }
            AsyncParseState::InDocument => {
                self.parse_document_content()?;
            }
            AsyncParseState::Complete => {}
        }
        Ok(())
    }

    /// Parse document content
    fn parse_document_content(&mut self) -> Result<()> {
        // Simplified parsing logic
        while !self.buffer.is_empty() {
            if self.buffer.starts_with("...") {
                self.emit_event(EventType::DocumentEnd { implicit: false })?;
                self.state = AsyncParseState::BetweenDocuments;
                self.buffer.drain(..3);
                break;
            }

            // Parse line by line (simplified)
            if let Some(newline_pos) = self.buffer.find('\n') {
                let line = self.buffer.drain(..=newline_pos).collect::<String>();
                self.parse_line(line)?;
            } else {
                break; // Need more data
            }
        }
        Ok(())
    }

    /// Parse a single line
    fn parse_line(&mut self, line: String) -> Result<()> {
        let trimmed = line.trim();

        if trimmed.is_empty() || trimmed.starts_with('#') {
            return Ok(());
        }

        // Simple key-value parsing
        if let Some(colon_pos) = trimmed.find(':') {
            let key = &trimmed[..colon_pos];
            let value = &trimmed[colon_pos + 1..];

            // Emit scalar events for key and value
            self.emit_event(EventType::Scalar {
                value: key.trim().to_string(),
                anchor: None,
                tag: None,
                style: crate::parser::ScalarStyle::Plain,
                plain_implicit: true,
                quoted_implicit: true,
            })?;

            self.emit_event(EventType::Scalar {
                value: value.trim().to_string(),
                anchor: None,
                tag: None,
                style: crate::parser::ScalarStyle::Plain,
                plain_implicit: true,
                quoted_implicit: true,
            })?;
        }

        Ok(())
    }

    /// Emit an event
    fn emit_event(&mut self, event_type: EventType) -> Result<()> {
        self.events.push_back(Event {
            event_type,
            position: self.position,
        });
        self.stats.events_generated += 1;
        Ok(())
    }

    /// Get the next event
    pub fn next_event(&mut self) -> Option<Event> {
        self.events.pop_front()
    }

    /// Check if parsing is complete
    pub fn is_complete(&self) -> bool {
        self.state == AsyncParseState::Complete && self.events.is_empty()
    }

    /// Get statistics
    pub fn stats(&self) -> &AsyncStreamStats {
        &self.stats
    }
}

#[cfg(feature = "async")]
impl<R: AsyncBufRead + Unpin> Stream for AsyncStreamingParser<R> {
    type Item = Result<Event>;

    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        // Check if we have buffered events
        if let Some(event) = self.next_event() {
            return Poll::Ready(Some(Ok(event)));
        }

        // If parsing is complete, return None
        if self.is_complete() {
            return Poll::Ready(None);
        }

        // Try to parse more data
        let waker = cx.waker().clone();

        // This is simplified - in production would use proper async runtime integration
        match futures::executor::block_on(self.parse_next()) {
            Ok(true) => {
                if let Some(event) = self.next_event() {
                    Poll::Ready(Some(Ok(event)))
                } else {
                    waker.wake();
                    Poll::Pending
                }
            }
            Ok(false) => Poll::Ready(None),
            Err(e) => Poll::Ready(Some(Err(e))),
        }
    }
}

/// Async helper functions
#[cfg(feature = "async")]
pub mod helpers {
    use super::*;
    use std::path::Path;
    use tokio::fs::File;

    /// Stream YAML from an async file
    pub async fn stream_from_file_async<P: AsRef<Path>>(
        path: P,
        limits: Limits,
    ) -> Result<AsyncStreamingParser<BufReader<File>>> {
        let file = File::open(path).await?;
        let reader = BufReader::new(file);
        Ok(AsyncStreamingParser::new(reader, limits))
    }

    /// Stream YAML from async reader
    pub fn stream_from_async_reader<R: AsyncBufRead + Unpin>(
        reader: R,
        limits: Limits,
    ) -> AsyncStreamingParser<R> {
        AsyncStreamingParser::new(reader, limits)
    }

    /// Process YAML stream with a callback
    pub async fn process_yaml_stream<R, F, Fut>(
        mut parser: AsyncStreamingParser<R>,
        mut callback: F,
    ) -> Result<()>
    where
        R: AsyncBufRead + Unpin,
        F: FnMut(Event) -> Fut,
        Fut: std::future::Future<Output = Result<()>>,
    {
        while !parser.is_complete() {
            if parser.parse_next().await? {
                while let Some(event) = parser.next_event() {
                    callback(event).await?;
                }
            }
        }
        Ok(())
    }
}

/// Memory-mapped file support for efficient large file processing
#[cfg(not(target_arch = "wasm32"))]
pub mod mmap {
    use crate::Result;
    use memmap2::{Mmap, MmapOptions};
    use std::fs::File;
    use std::path::Path;

    /// Memory-mapped YAML file reader
    pub struct MmapYamlReader {
        mmap: Mmap,
        position: usize,
    }

    impl MmapYamlReader {
        /// Create a new memory-mapped reader
        pub fn new<P: AsRef<Path>>(path: P) -> Result<Self> {
            let file = File::open(path)?;
            // Note: Using memory mapping which is inherently unsafe but contained
            // This is acceptable for file I/O in controlled environments
            #[allow(unsafe_code)]
            let mmap = unsafe { MmapOptions::new().map(&file)? };

            Ok(Self { mmap, position: 0 })
        }

        /// Get the entire content as a string slice
        pub fn as_str(&self) -> Result<&str> {
            std::str::from_utf8(&self.mmap).map_err(|e| {
                crate::Error::construction(
                    crate::Position::new(),
                    format!("UTF-8 conversion failed: {}", e),
                )
            })
        }

        /// Read a chunk from current position
        pub fn read_chunk(&mut self, size: usize) -> Option<&str> {
            if self.position >= self.mmap.len() {
                return None;
            }

            let end = (self.position + size).min(self.mmap.len());
            let chunk = &self.mmap[self.position..end];
            self.position = end;

            std::str::from_utf8(chunk).ok()
        }

        /// Reset position to beginning
        pub fn reset(&mut self) {
            self.position = 0;
        }

        /// Get remaining bytes
        pub fn remaining(&self) -> usize {
            self.mmap.len().saturating_sub(self.position)
        }
    }
}

#[cfg(all(test, feature = "async"))]
mod async_tests {
    use super::*;
    use futures::StreamExt;
    use std::io::Cursor;

    #[tokio::test]
    async fn test_async_streaming() {
        const MAX_ITERATIONS: usize = 100;

        let yaml = "---\nkey: value\n...\n";
        let cursor = Cursor::new(yaml.as_bytes().to_vec());
        let reader = BufReader::new(cursor);
        let mut parser = AsyncStreamingParser::new(reader, Limits::default());

        let mut events = Vec::new();
        let mut iterations = 0;

        while !parser.is_complete() && iterations < MAX_ITERATIONS {
            iterations += 1;
            match parser.parse_next().await {
                Ok(has_events) => {
                    if has_events {
                        while let Some(event) = parser.next_event() {
                            events.push(event);
                        }
                    } else if parser.state == AsyncParseState::Complete {
                        // Ensure we exit when parsing is done
                        break;
                    }
                }
                Err(_) => break,
            }
        }

        assert!(!events.is_empty());
        assert!(matches!(events[0].event_type, EventType::StreamStart));
    }

    #[tokio::test]
    async fn test_stream_trait() {
        use tokio::time::{timeout, Duration};

        let yaml = "key: value\n";
        let cursor = Cursor::new(yaml.as_bytes().to_vec());
        let reader = BufReader::new(cursor);
        let mut parser = AsyncStreamingParser::new(reader, Limits::default());

        let result = timeout(Duration::from_secs(5), parser.take(5).collect::<Vec<_>>()).await;

        let events = result.expect("Test timed out after 5 seconds");
        assert!(!events.is_empty());
    }
}

#[cfg(all(test, not(target_arch = "wasm32")))]
mod mmap_tests {
    use super::mmap::*;
    use std::io::Write;
    use tempfile::NamedTempFile;

    #[test]
    fn test_mmap_reader() {
        // Create a temporary file
        let mut file = NamedTempFile::new().unwrap();
        writeln!(file, "key: value").unwrap();
        writeln!(file, "list:").unwrap();
        writeln!(file, "  - item1").unwrap();
        writeln!(file, "  - item2").unwrap();
        file.flush().unwrap();

        // Test memory-mapped reading
        let mut reader = MmapYamlReader::new(file.path()).unwrap();
        let content = reader.as_str().unwrap();
        assert!(content.contains("key: value"));

        // Test chunk reading
        reader.reset();
        let chunk = reader.read_chunk(10).unwrap();
        assert_eq!(chunk, "key: value");
    }
}