stak-device 0.12.15

Devices for Stak Scheme
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

use crate::{BufferError, Device};
use winter_maybe_async::maybe_async;

/// A fixed buffer device.
#[derive(Debug)]
pub struct FixedBufferDevice<'a, const O: usize, const E: usize> {
    input: &'a [u8],
    output: [u8; O],
    error: [u8; E],
    input_index: usize,
    output_index: usize,
    error_index: usize,
}

impl<'a, const O: usize, const E: usize> FixedBufferDevice<'a, O, E> {
    /// Creates a device.
    pub const fn new(input: &'a [u8]) -> Self {
        Self {
            input,
            output: [0; O],
            error: [0; E],
            input_index: 0,
            output_index: 0,
            error_index: 0,
        }
    }

    /// Returns a reference to standard output.
    pub fn output(&self) -> &[u8] {
        &self.output[..self.output_index]
    }

    /// Returns a reference to standard error.
    pub fn error(&self) -> &[u8] {
        &self.error[..self.error_index]
    }
}

impl<const O: usize, const E: usize> Device for FixedBufferDevice<'_, O, E> {
    type Error = BufferError;

    #[maybe_async]
    fn read(&mut self) -> Result<Option<u8>, Self::Error> {
        Ok(if let Some(&byte) = self.input.get(self.input_index) {
            self.input_index += 1;

            Some(byte)
        } else {
            None
        })
    }

    #[maybe_async]
    fn write(&mut self, byte: u8) -> Result<(), Self::Error> {
        let Some(output) = self.output.get_mut(self.output_index) else {
            return Err(BufferError::Write);
        };

        *output = byte;
        self.output_index += 1;

        Ok(())
    }

    #[maybe_async]
    fn write_error(&mut self, byte: u8) -> Result<(), Self::Error> {
        let Some(error) = self.error.get_mut(self.error_index) else {
            return Err(BufferError::Write);
        };

        *error = byte;
        self.error_index += 1;

        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use stak_util::block_on;

    #[test]
    fn read() {
        let mut device = FixedBufferDevice::<0, 0>::new(&[42]);

        assert_eq!(block_on!(device.read()), Ok(Some(42)));
        assert_eq!(block_on!(device.read()), Ok(None));
    }

    #[test]
    fn write() {
        let mut device = FixedBufferDevice::<1, 0>::new(&[]);

        assert_eq!(block_on!(device.write(42)), Ok(()));
        assert_eq!(block_on!(device.write(42)), Err(BufferError::Write));
        assert_eq!(device.output(), [42]);
    }

    #[test]
    fn write_error() {
        let mut device = FixedBufferDevice::<0, 1>::new(&[]);

        assert_eq!(block_on!(device.write_error(42)), Ok(()));
        assert_eq!(block_on!(device.write_error(42)), Err(BufferError::Write));
        assert_eq!(device.error(), [42]);
    }
}