rdif-base 0.8.5

Driver Interface base definition.
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
use alloc::{boxed::Box, vec::Vec};

use axtest::prelude::*;

use crate::{
    DriverGeneric,
    io::{Error, ErrorKind, Read, Write},
};

pub trait DemoInterface: DriverGeneric {
    fn value(&self) -> usize;
    fn set_value(&mut self, value: usize);
}

crate::def_driver!(DemoDriver, DemoInterface);

struct DemoBackend {
    value: usize,
}

impl DriverGeneric for DemoBackend {
    fn name(&self) -> &str {
        "demo-backend"
    }

    fn raw_any(&self) -> Option<&dyn core::any::Any> {
        Some(self)
    }

    fn raw_any_mut(&mut self) -> Option<&mut dyn core::any::Any> {
        Some(self)
    }
}

impl DemoInterface for DemoBackend {
    fn value(&self) -> usize {
        self.value
    }

    fn set_value(&mut self, value: usize) {
        self.value = value;
    }
}

struct ChunkedReader {
    chunks: Vec<&'static [u8]>,
}

impl Read for ChunkedReader {
    fn read(&mut self, buf: &mut [u8]) -> crate::io::Result {
        let Some(chunk) = self.chunks.pop() else {
            return Err(Error {
                kind: ErrorKind::InvalidData,
                success_pos: 0,
            });
        };
        let count = chunk.len().min(buf.len());
        buf[..count].copy_from_slice(&chunk[..count]);
        if count < buf.len() {
            return Err(Error {
                kind: ErrorKind::Interrupted,
                success_pos: count,
            });
        }
        Ok(())
    }
}

struct ChunkedWriter {
    accepted: Vec<u8>,
    limit: usize,
}

impl Write for ChunkedWriter {
    fn write(&mut self, buf: &[u8]) -> crate::io::Result {
        let count = self.limit.min(buf.len());
        self.accepted.extend_from_slice(&buf[..count]);
        if count < buf.len() {
            return Err(Error {
                kind: ErrorKind::Interrupted,
                success_pos: count,
            });
        }
        Ok(())
    }
}

#[axtest]
fn rdif_base_def_driver_wraps_and_downcasts_backends() {
    let mut driver = DemoDriver::new(DemoBackend { value: 7 });

    ax_assert_eq!(driver.name(), "demo-backend");
    ax_assert_eq!(driver.value(), 7);
    driver.set_value(11);
    ax_assert_eq!(driver.typed_ref::<DemoBackend>().unwrap().value, 11);
    driver.typed_mut::<DemoBackend>().unwrap().value = 13;
    ax_assert_eq!(driver.value(), 13);
}

#[axtest]
fn rdif_base_blocking_io_retries_interrupted_progress() {
    let mut reader = ChunkedReader {
        chunks: alloc::vec![b"cd", b"ab"],
    };
    let mut buf = [0; 4];
    reader.read_all_blocking(&mut buf).unwrap();
    ax_assert_eq!(&buf, b"abcd");

    let mut writer = ChunkedWriter {
        accepted: Vec::new(),
        limit: 2,
    };
    writer.write_all_blocking(b"abcd").unwrap();
    ax_assert_eq!(writer.accepted, alloc::vec![b'a', b'b', b'c', b'd']);
}

#[axtest]
fn rdif_base_io_errors_preserve_kind_and_success_position() {
    let error = Error {
        kind: ErrorKind::InvalidParameter { name: "baudrate" },
        success_pos: 3,
    };

    ax_assert_eq!(error.success_pos, 3);
    ax_assert!(alloc::format!("{error}").contains("success pos 3"));
    ax_assert!(matches!(
        error.kind,
        ErrorKind::InvalidParameter { name: "baudrate" }
    ));

    let other = ErrorKind::Other(Box::new(Error {
        kind: ErrorKind::WriteZero,
        success_pos: 0,
    }));
    ax_assert!(matches!(other, ErrorKind::Other(_)));
}

#[axtest]
fn rdif_base_error_kind_variants_hold() {
    // Check that all ErrorKind variants exist and are distinct
    let kinds = [
        ErrorKind::NotAvailable,
        ErrorKind::BrokenPipe,
        ErrorKind::InvalidData,
        ErrorKind::TimedOut,
        ErrorKind::Interrupted,
        ErrorKind::Unsupported,
        ErrorKind::OutOfMemory,
        ErrorKind::InvalidParameter { name: "test" },
    ];

    // Just verify they can be created and matched
    for kind in &kinds {
        match kind {
            ErrorKind::NotAvailable => {}
            ErrorKind::BrokenPipe => {}
            ErrorKind::InvalidData => {}
            ErrorKind::TimedOut => {}
            ErrorKind::Interrupted => {}
            ErrorKind::Unsupported => {}
            ErrorKind::OutOfMemory => {}
            ErrorKind::InvalidParameter { .. } => {}
            ErrorKind::Other(_) => {}
            ErrorKind::WriteZero => {}
        }
    }
}

#[axtest]
fn rdif_base_read_write_trait_dispatch_hold() {
    use crate::{
        DriverGeneric,
        io::{Error, Read, Write},
    };

    struct TestBackend {
        data: Vec<u8>,
        read_pos: usize,
    }

    impl DriverGeneric for TestBackend {
        fn name(&self) -> &str {
            "test-backend"
        }
    }

    impl Read for TestBackend {
        fn read(&mut self, buf: &mut [u8]) -> Result<(), Error> {
            let remaining = self.data.len() - self.read_pos;
            if remaining == 0 {
                return Ok(());
            }
            let count = buf.len().min(remaining);
            buf[..count].copy_from_slice(&self.data[self.read_pos..self.read_pos + count]);
            self.read_pos += count;
            Ok(())
        }
    }

    impl Write for TestBackend {
        fn write(&mut self, buf: &[u8]) -> Result<(), Error> {
            self.data.extend_from_slice(buf);
            Ok(())
        }
    }

    let mut backend = TestBackend {
        data: Vec::from(b"hello".as_slice()),
        read_pos: 0,
    };

    // Test read
    let mut buf = [0; 5];
    let _ = backend.read(&mut buf);
    ax_assert_eq!(&buf, b"hello");

    // Test write
    let _ = backend.write(b" world");
    ax_assert_eq!(backend.data, b"hello world");
}

#[axtest]
fn rdif_base_error_conversion_and_chaining_hold() {
    use crate::io::{Error, ErrorKind};

    // Test error creation with different kinds
    let err1 = Error {
        kind: ErrorKind::InvalidData,
        success_pos: 0,
    };
    ax_assert!(matches!(err1.kind, ErrorKind::InvalidData));

    let err2 = Error {
        kind: ErrorKind::TimedOut,
        success_pos: 0,
    };
    ax_assert!(matches!(err2.kind, ErrorKind::TimedOut));

    // Test error with success position
    let err3 = Error {
        kind: ErrorKind::Interrupted,
        success_pos: 5,
    };
    ax_assert_eq!(err3.success_pos, 5);

    // Test Other variant
    let inner = Error {
        kind: ErrorKind::WriteZero,
        success_pos: 0,
    };
    let outer = ErrorKind::Other(Box::new(inner));
    ax_assert!(matches!(outer, ErrorKind::Other(_)));
}

#[axtest]
fn rdif_base_seek_and_io_traits_hold() {
    use crate::io::{Error, ErrorKind, Read, Write};

    struct VecWriter {
        data: Vec<u8>,
        pos: usize,
    }

    impl VecWriter {
        fn new() -> Self {
            Self {
                data: Vec::new(),
                pos: 0,
            }
        }
    }

    impl Write for VecWriter {
        fn write(&mut self, buf: &[u8]) -> Result<(), Error> {
            self.data.extend_from_slice(buf);
            self.pos += buf.len();
            Ok(())
        }
    }

    impl Read for VecWriter {
        fn read(&mut self, buf: &mut [u8]) -> Result<(), Error> {
            let remaining = self.data.len().saturating_sub(self.pos);
            let to_copy = remaining.min(buf.len());
            buf[..to_copy].copy_from_slice(&self.data[self.pos..self.pos + to_copy]);
            self.pos += to_copy;
            Ok(())
        }
    }

    let mut writer = VecWriter::new();
    writer.write(b"hello").unwrap();
    writer.write(b" world").unwrap();
    ax_assert_eq!(writer.data, b"hello world");
    ax_assert_eq!(writer.pos, 11);

    // Reset position and read back
    writer.pos = 6;
    let mut buf = [0_u8; 5];
    writer.read(&mut buf).unwrap();
    ax_assert_eq!(&buf, b"world");

    // Test error kinds for coverage
    let _not_available = ErrorKind::NotAvailable;
    let _broken_pipe = ErrorKind::BrokenPipe;
    let _unsupported = ErrorKind::Unsupported;
    let _out_of_memory = ErrorKind::OutOfMemory;
}

#[axtest]
fn rdif_base_driver_generic_name_and_any_hold() {
    use crate::DriverGeneric;

    struct NamedBackend {
        name_str: &'static str,
    }

    impl DriverGeneric for NamedBackend {
        fn name(&self) -> &str {
            self.name_str
        }

        fn raw_any(&self) -> Option<&dyn core::any::Any> {
            None
        }

        fn raw_any_mut(&mut self) -> Option<&mut dyn core::any::Any> {
            None
        }
    }

    let mut backend = NamedBackend {
        name_str: "test-driver",
    };
    ax_assert_eq!(backend.name(), "test-driver");
    ax_assert!(backend.raw_any().is_none());
    ax_assert!(backend.raw_any_mut().is_none());
}

#[axtest]
fn rdif_base_io_read_empty_and_partial_hold() {
    use crate::io::{Error, Read};

    // Test reading from empty source
    struct EmptyReader;
    impl Read for EmptyReader {
        fn read(&mut self, _buf: &mut [u8]) -> Result<(), Error> {
            Ok(())
        }
    }

    let mut reader = EmptyReader;
    let mut buf = [0u8; 10];
    reader.read(&mut buf).unwrap();
    ax_assert_eq!(buf[0], 0);

    // Test partial read
    struct PartialReader {
        data: &'static [u8],
        pos: usize,
    }
    impl Read for PartialReader {
        fn read(&mut self, buf: &mut [u8]) -> Result<(), Error> {
            if self.pos >= self.data.len() {
                return Ok(());
            }
            let to_copy = (self.data.len() - self.pos).min(buf.len());
            buf[..to_copy].copy_from_slice(&self.data[self.pos..self.pos + to_copy]);
            self.pos += to_copy;
            Ok(())
        }
    }

    let mut partial = PartialReader {
        data: b"hi",
        pos: 0,
    };
    let mut buf2 = [0u8; 10];
    partial.read(&mut buf2).unwrap();
    ax_assert_eq!(&buf2[..2], b"hi");
}

#[axtest]
fn rdif_base_io_write_multiple_calls_hold() {
    use crate::io::{Error, Write};

    // Test multiple write calls accumulate correctly
    struct AccumulatingWriter {
        data: Vec<u8>,
    }
    impl Write for AccumulatingWriter {
        fn write(&mut self, buf: &[u8]) -> Result<(), Error> {
            self.data.extend_from_slice(buf);
            Ok(())
        }
    }

    let mut writer = AccumulatingWriter { data: Vec::new() };
    writer.write(b"a").unwrap();
    writer.write(b"b").unwrap();
    writer.write(b"c").unwrap();
    ax_assert_eq!(writer.data, b"abc");

    // Test empty write
    writer.write(b"").unwrap();
    ax_assert_eq!(writer.data.len(), 3);
}