cheats 0.4.0

A game shell backend.
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

// Copyright 2020 Eray Erdin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use log::*;
use std::io;

#[derive(Clone)]
/// A stream to use as output and input for game shell.
pub struct Stream {
    buffer: Vec<u8>,
}

impl Stream {
    pub fn new() -> Self {
        debug!("Initializing Stream...");
        Stream { buffer: vec![] }
    }
}

impl io::Read for Stream {
    fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
        debug!("Reading from stream...");

        let length = buf.len();
        trace!("buffer length: {}", length);

        debug!("Reading bytes to buffer...");
        let mut byte_count = 0usize;
        for i in 0..length {
            match self.buffer.get(0) {
                Some(byte) => {
                    buf[i] = byte.clone();
                    byte_count += 1;
                    self.buffer.remove(0);
                }
                None => {
                    break;
                }
            }
        }

        trace!("Total bytes read: {}", byte_count);
        Ok(byte_count)
    }
}

impl io::Write for Stream {
    fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
        debug!("Writing to stream...");
        trace!("buffer length: {}", buf.len());

        #[allow(unused_imports)]
        use std::io::Write; // required for writing to buffer

        self.buffer.write(buf).unwrap_or(0);
        Ok(buf.len())
    }
    /// Does nothing.
    fn flush(&mut self) -> std::io::Result<()> {
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use rstest::*;
    use std::io::{Read, Write};

    #[fixture]
    fn stream() -> Stream {
        let mut stream = Stream::new();
        stream.buffer.extend(b"lorem");
        stream
    }

    #[rstest]
    fn read(mut stream: Stream) {
        let mut msg = String::new();
        let mut buffer: [u8; 8] = [0; 8];

        let byte_count = stream
            .read(&mut buffer)
            .expect("Could not read from Stream.");
        msg.extend(
            buffer
                .iter()
                .filter(|n| **n != 0u8)
                .map(|n| n.clone() as char),
        );

        assert_eq!(byte_count, 5);
        assert_eq!(msg, "lorem");
        assert!(stream.buffer.is_empty());
    }

    #[rstest]
    fn write(mut stream: Stream) {
        let buffer = b" ipsum";
        let mut expected_msg = String::new();
        expected_msg.extend("lorem".chars());
        buffer
            .iter()
            .for_each(|c| expected_msg.push(c.clone() as char));

        let byte_count = stream.write(buffer).expect("Could not write to Stream.");
        let mut msg = String::new();
        msg.extend(stream.buffer.iter().map(|c| c.clone() as char));

        assert_eq!(byte_count, buffer.len());
        assert_eq!(stream.buffer.len(), byte_count + 5);
        assert_eq!(expected_msg, msg);
    }
}