round_pipers 0.2.0

A way to pipe ndarrays using circular buffers
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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
use crate::array_helpers;
use crate::buffer::Buffer;
use crate::error::Result;
use crate::pipe_common::{MetadataManager, PipeState, ShapeManager};
use crate::traits::{SizedDimension, Writable};
use bytemuck::Zeroable;
use ndarray::{ArrayViewMut, Dimension, StrideShape};
use std::cell::RefCell;
use std::io::Write;
use std::marker::PhantomData;

/// A write-only pipe that provides access to a pre-allocated mutable slice
/// Simple API: WriteOnlyPipeBuffer::new(my_mut_slice) - no copying, uses lifetimes to ensure slice survives
pub struct WriteOnlyPipeBuffer<'data, A: Copy + Zeroable, D: SizedDimension + Dimension, M: Clone> {
    data: RefCell<&'data mut [A]>,
    nelements: usize,
    shape_manager: ShapeManager<D>,
    write_ptr: RefCell<usize>,
    metadata_manager: MetadataManager<M>,
}

impl<'data, A: Copy + Zeroable, D: SizedDimension + Dimension, M: Clone>
    WriteOnlyPipeBuffer<'data, A, D, M>
{
    /// Create a new write-only pipe from a mutable slice
    /// The slice must outlive the WriteOnlyPipeBuffer (enforced by lifetimes)
    pub fn new<Sh: Into<StrideShape<D>>>(
        data: &'data mut [A],
        shape_input: Sh,
    ) -> Result<WriteOnlyPipeBuffer<'data, A, D, M>> {
        let shape_manager = ShapeManager::new(shape_input);
        let nelements = data.len() / shape_manager.element_size();

        Ok(WriteOnlyPipeBuffer {
            data: RefCell::new(data),
            nelements,
            shape_manager,
            write_ptr: RefCell::new(0),
            metadata_manager: MetadataManager::new(),
        })
    }

    pub fn get_metadata(&self) -> Option<M> {
        self.metadata_manager.get()
    }

    pub fn set_metadata(&self, m: M) {
        self.metadata_manager.set(m);
    }
}

impl<'data, A: Copy + Zeroable, D: SizedDimension + Dimension, M: Clone> Writable<A, D, M>
    for WriteOnlyPipeBuffer<'data, A, D, M>
{
    fn write<R>(
        &self,
        n_to_write: usize,
        f: impl FnOnce(ArrayViewMut<A, D::Larger>, PipeState) -> R,
    ) -> Result<R>
    where
        D::LargerSize: Into<StrideShape<D::Larger>> + Clone,
        D::CurrentSize: Clone,
    {
        let mut write_ptr = self.write_ptr.borrow_mut();

        // Validate bounds using common helper
        array_helpers::validate_bounds(*write_ptr, n_to_write, self.nelements, "Write-only pipe")?;

        // Create the mutable array view using common helper
        let mut data_ref = self.data.borrow_mut();
        let data = array_helpers::create_write_view(
            &mut data_ref,
            *write_ptr,
            n_to_write,
            &self.shape_manager,
        )?;

        let pipe_state = PipeState {
            write_ptr: *write_ptr,
            read_ptr: 0, // For write-only pipes, read_ptr is always 0
        };

        let result = f(data, pipe_state);

        // Advance the write pointer
        *write_ptr += n_to_write;

        Ok(result)
    }

    fn set_metadata(&self, metadata: &M) {
        self.set_metadata(metadata.clone());
    }
}

/// A write-only pipe that streams data to any std::io::Write implementor
/// Owns a buffer that grows as needed, writes data to the target after successful processing
pub struct WriteOnlyPipeStream<
    W: Write,
    A: Copy + Zeroable,
    D: SizedDimension + Dimension,
    M: Clone,
> {
    writer: RefCell<W>,
    buffer: RefCell<Buffer>,
    shape_manager: ShapeManager<D>,
    metadata_manager: MetadataManager<M>,
    _phantom: PhantomData<A>,
}

impl<W: Write, A: Copy + Zeroable, D: SizedDimension + Dimension, M: Clone>
    WriteOnlyPipeStream<W, A, D, M>
{
    /// Create a new write-only pipe stream
    /// writer: The target that implements std::io::Write
    /// min_buffer_size: Initial buffer size in elements (will be converted to bytes)
    /// shape_input: Shape for the ndarray views
    pub fn new<Sh: Into<StrideShape<D>>>(
        writer: W,
        min_buffer_size: usize,
        shape_input: Sh,
    ) -> Result<WriteOnlyPipeStream<W, A, D, M>> {
        let shape_manager = ShapeManager::new(shape_input);

        // Create buffer with minimum size in bytes
        let min_bytes = min_buffer_size * std::mem::size_of::<A>();
        let buffer = Buffer::with_capacity(min_bytes);

        Ok(WriteOnlyPipeStream {
            writer: RefCell::new(writer),
            buffer: RefCell::new(buffer),
            shape_manager,
            metadata_manager: MetadataManager::new(),
            _phantom: PhantomData,
        })
    }

    pub fn get_metadata(&self) -> Option<M> {
        self.metadata_manager.get()
    }

    pub fn set_metadata(&self, m: M) {
        self.metadata_manager.set(m);
    }

    /// Extract the writer, consuming the pipe
    /// Useful for getting the final data from writers like Cursor
    pub fn into_writer(self) -> W {
        self.writer.into_inner()
    }
}

impl<W: Write, A: Copy + Zeroable, D: SizedDimension + Dimension, M: Clone> Writable<A, D, M>
    for WriteOnlyPipeStream<W, A, D, M>
{
    fn write<R>(
        &self,
        n_to_write: usize,
        f: impl FnOnce(ArrayViewMut<A, D::Larger>, PipeState) -> R,
    ) -> Result<R>
    where
        D::LargerSize: Into<StrideShape<D::Larger>> + Clone,
        D::CurrentSize: Clone,
    {
        let mut buffer = self.buffer.borrow_mut();

        // Ensure buffer has enough space for n_to_write elements
        let required_elements = self.shape_manager.total_scalars(n_to_write);
        let required_bytes = required_elements * std::mem::size_of::<A>();
        buffer.resize_to_fit(required_bytes);

        // Create the mutable array view using common helper
        let slice: &mut [A] = buffer.view_mut()?;
        let data = array_helpers::create_write_view(
            slice,
            0, // Always start at 0 for stream pipes
            n_to_write,
            &self.shape_manager,
        )?;

        let pipe_state = PipeState {
            write_ptr: 0, // Always start at 0 for stream pipes
            read_ptr: 0,
        };

        // Call the user function
        let result = f(data, pipe_state);

        // If we got here, the user function succeeded, so write to the target
        let bytes_to_write = &buffer.as_bytes()[..required_bytes];
        let mut writer = self.writer.borrow_mut();
        writer.write_all(bytes_to_write)?;
        writer.flush()?;

        Ok(result)
    }

    fn set_metadata(&self, metadata: &M) {
        self.set_metadata(metadata.clone());
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::error::{PipeError, Result};
    use ndarray::Ix0;

    #[test]
    fn test_writeonly_pipe_basic() -> Result<()> {
        // Create some test data buffer
        let mut data: Vec<f64> = vec![0.0; 100];

        {
            // Create a write-only pipe - simple API as requested
            let pipe = WriteOnlyPipeBuffer::<f64, Ix0, ()>::new(&mut data, [])?;

            // Test writing data directly to the pipe
            pipe.write(25, |mut chunk, _state| {
                for (i, value) in chunk.iter_mut().enumerate() {
                    *value = i as f64;
                }
            })?;

            // Write more data
            pipe.write(25, |mut chunk, _state| {
                for (i, value) in chunk.iter_mut().enumerate() {
                    *value = (25 + i) as f64;
                }
            })?;
        } // pipe drops here, releasing the mutable borrow

        // Now we can verify data was written
        for (i, &value) in data[..25].iter().enumerate() {
            assert_eq!(value, i as f64);
        }

        // Verify second write
        for (i, &value) in data[25..50].iter().enumerate() {
            assert_eq!(value, (25 + i) as f64);
        }

        Ok(())
    }

    #[test]
    fn test_writeonly_pipe_end_of_space() -> Result<()> {
        let mut data: Vec<f64> = vec![0.0; 10];
        let pipe = WriteOnlyPipeBuffer::<f64, Ix0, ()>::new(&mut data, [])?;

        // Write all space
        pipe.write(10, |mut chunk, _state| {
            for (i, value) in chunk.iter_mut().enumerate() {
                *value = i as f64;
            }
        })?;

        // Try to write more - should get an error
        let result = pipe.write(5, |_chunk, _state| {});
        assert!(result.is_err());
        let error = result.unwrap_err();
        assert!(error.is_insufficient_data());

        Ok(())
    }

    #[test]
    fn test_writeonly_pipe_metadata() -> Result<()> {
        let mut data: Vec<f64> = vec![0.0; 50];
        let pipe = WriteOnlyPipeBuffer::<f64, Ix0, String>::new(&mut data, [])?;

        // Initially no metadata
        assert_eq!(pipe.get_metadata(), None);

        // Set metadata
        pipe.set_metadata("test_metadata".to_string());
        assert_eq!(pipe.get_metadata(), Some("test_metadata".to_string()));

        // Write some data
        pipe.write(20, |mut chunk, _state| {
            for (i, value) in chunk.iter_mut().enumerate() {
                *value = i as f64;
            }
        })?;

        // Metadata should still be there
        assert_eq!(pipe.get_metadata(), Some("test_metadata".to_string()));

        Ok(())
    }

    #[test]
    fn test_writeonly_pipe_write_from_source() -> Result<()> {
        let mut data: Vec<f64> = vec![0.0; 50];

        {
            let pipe = WriteOnlyPipeBuffer::<f64, Ix0, ()>::new(&mut data, [])?;

            // Create source data
            let source: Vec<f64> = (0..20).map(|i| i as f64).collect();

            // Write data from source slice using the write method
            pipe.write(20, |mut chunk, _state| {
                for (i, value) in chunk.iter_mut().enumerate() {
                    *value = source[i];
                }
            })?;
        }

        // Verify data was written
        for (i, &value) in data[..20].iter().enumerate() {
            assert_eq!(value, i as f64);
        }

        Ok(())
    }

    #[test]
    fn test_writeonly_pipe_partial_writes() -> Result<()> {
        let mut data: Vec<f64> = vec![0.0; 30];
        let pipe = WriteOnlyPipeBuffer::<f64, Ix0, ()>::new(&mut data, [])?;

        // Write in small chunks
        for chunk_idx in 0..3 {
            pipe.write(10, |mut chunk, state| {
                assert_eq!(state.write_ptr, chunk_idx * 10);
                for (i, value) in chunk.iter_mut().enumerate() {
                    *value = (chunk_idx * 10 + i) as f64;
                }
            })?;
        }

        Ok(())
    }

    // WriteOnlyPipeStream tests
    #[test]
    fn test_writeonly_pipe_stream_basic() -> Result<()> {
        let mut output = Vec::new();

        {
            let pipe = WriteOnlyPipeStream::<_, f64, Ix0, ()>::new(&mut output, 10, [])?;

            // Write some data
            pipe.write(5, |mut chunk, _state| {
                for (i, value) in chunk.iter_mut().enumerate() {
                    *value = i as f64;
                }
            })?;
        } // pipe drops here, ensuring all data is written

        // Verify the data was written to the output as bytes
        assert_eq!(output.len(), 5 * 8); // 5 f64s = 40 bytes

        let mut buffer = Buffer::new(output.len());
        buffer.as_bytes_mut().copy_from_slice(&output);
        let f64_slice: &[f64] = buffer.view()?;

        for (i, &value) in f64_slice.iter().enumerate() {
            assert_eq!(value, i as f64);
        }

        Ok(())
    }

    #[test]
    fn test_writeonly_pipe_stream_buffer_growth() -> Result<()> {
        let mut output = Vec::new();

        {
            let pipe = WriteOnlyPipeStream::<_, f64, Ix0, ()>::new(&mut output, 5, [])?;

            // First write - should fit in initial buffer
            pipe.write(3, |mut chunk, _state| {
                for (i, value) in chunk.iter_mut().enumerate() {
                    *value = i as f64;
                }
            })?;

            // Second write - larger than initial buffer, should grow
            pipe.write(10, |mut chunk, _state| {
                for (i, value) in chunk.iter_mut().enumerate() {
                    *value = (100 + i) as f64;
                }
            })?;
        }

        // Verify both writes made it to output
        assert_eq!(output.len(), (3 + 10) * 8); // Total bytes written

        Ok(())
    }

    #[test]
    fn test_writeonly_pipe_stream_metadata() -> Result<()> {
        let mut output = Vec::new();
        let pipe = WriteOnlyPipeStream::<_, f64, Ix0, String>::new(&mut output, 10, [])?;

        // Test metadata operations
        assert_eq!(pipe.get_metadata(), None);

        pipe.set_metadata("test metadata".to_string());
        assert_eq!(pipe.get_metadata(), Some("test metadata".to_string()));

        // Metadata should persist through writes
        pipe.write(5, |mut chunk, _state| {
            for (i, value) in chunk.iter_mut().enumerate() {
                *value = i as f64;
            }
        })?;

        assert_eq!(pipe.get_metadata(), Some("test metadata".to_string()));

        Ok(())
    }

    #[test]
    fn test_writeonly_pipe_stream_write_error_handling() -> Result<()> {
        // Create a mock writer that will fail
        struct FailingWriter {
            should_fail: bool,
        }

        impl Write for FailingWriter {
            fn write(&mut self, _buf: &[u8]) -> std::io::Result<usize> {
                if self.should_fail {
                    Err(std::io::Error::new(
                        std::io::ErrorKind::Other,
                        "Mock write failure",
                    ))
                } else {
                    Ok(0)
                }
            }

            fn flush(&mut self) -> std::io::Result<()> {
                Ok(())
            }
        }

        let failing_writer = FailingWriter { should_fail: true };
        let pipe = WriteOnlyPipeStream::<_, f64, Ix0, ()>::new(failing_writer, 10, [])?;

        // Write should fail due to I/O error
        let result = pipe.write(5, |mut chunk, _state| {
            for (i, value) in chunk.iter_mut().enumerate() {
                *value = i as f64;
            }
        });

        assert!(result.is_err());
        // Check that it's an I/O error (the mock write failure gets wrapped)
        assert!(matches!(result.unwrap_err(), PipeError::IoError(_)));

        Ok(())
    }

    #[test]
    fn test_writeonly_pipe_stream_with_cursor() -> Result<()> {
        use std::io::Cursor;

        let buffer = Vec::new();
        let cursor = Cursor::new(buffer);

        let pipe = WriteOnlyPipeStream::<_, u32, Ix0, ()>::new(cursor, 8, [])?;

        // Write some u32 data
        pipe.write(4, |mut chunk, state| {
            assert_eq!(state.write_ptr, 0);
            assert_eq!(state.read_ptr, 0);

            for (i, value) in chunk.iter_mut().enumerate() {
                *value = (i * i) as u32; // 0, 1, 4, 9
            }
        })?;

        // Get the cursor back and verify data
        let final_cursor = pipe.writer.into_inner();
        let final_buffer = final_cursor.into_inner();

        assert_eq!(final_buffer.len(), 4 * 4); // 4 u32s = 16 bytes

        let mut buffer = Buffer::new(final_buffer.len());
        buffer.as_bytes_mut().copy_from_slice(&final_buffer);
        let u32_slice: &[u32] = buffer.view()?;

        assert_eq!(u32_slice, &[0, 1, 4, 9]);

        Ok(())
    }

    #[test]
    fn test_writeonly_pipe_stream_into_writer() -> Result<()> {
        use std::io::Cursor;

        let buffer = Vec::new();
        let cursor = Cursor::new(buffer);

        let pipe = WriteOnlyPipeStream::<_, u8, Ix0, ()>::new(cursor, 5, [])?;

        // Write some data
        pipe.write(4, |mut chunk, _state| {
            for (i, value) in chunk.iter_mut().enumerate() {
                *value = (i + 65) as u8; // ASCII 'A', 'B', 'C', 'D'
            }
        })?;

        // Extract the writer and verify data
        let final_cursor = pipe.into_writer();
        let final_data = final_cursor.into_inner();

        assert_eq!(final_data, &[65, 66, 67, 68]); // ASCII 'A', 'B', 'C', 'D'

        Ok(())
    }

    #[test]
    fn test_write_bounds_error() -> Result<()> {
        use crate::error::PipeError;

        let mut data = vec![0.0; 5];
        let pipe = WriteOnlyPipeBuffer::<f64, Ix0, ()>::new(&mut data, [])?;

        // Try to write more data than buffer capacity - should fail with insufficient data error
        match pipe.write(10, |_chunk, _state| {}) {
            Err(error) if error.is_insufficient_data() => {
                // Test passed - error correctly identified as insufficient data
            }
            other => panic!("Expected bounds error, got: {:?}", other),
        }

        // Also test that the specific error type is correct
        match pipe.write(8, |_chunk, _state| {}) {
            Err(PipeError::InsufficientData {
                context,
                requested,
                position,
                available,
            }) => {
                assert_eq!(context, "Write-only pipe");
                assert_eq!(requested, 8);
                assert_eq!(position, 0);
                assert_eq!(available, 5);
            }
            other => panic!("Expected InsufficientData error, got: {:?}", other),
        }

        Ok(())
    }
}