Struct brainfoamkit_lib::MockReader

pub struct MockReader {
    pub data: Cursor<Vec<u8>>,
}

The MockReader struct

This struct is used to implement a mock Reader for the VirtualMachine. This allows for us to test the VirtualMachine without having to use Stdin or File as the Reader.

This struct is used for testing purposes only, and should not be used in production code.

Examples

use brainfoamkit_lib::VMReader;

let mut mock = brainfoamkit_lib::MockReader {
    data: std::io::Cursor::new("A".as_bytes().to_vec()),
};

assert_eq!(mock.read().unwrap(), 65);

See Also

• VMReader
• VMReaderType
• Stdin
• File

Fields

data: Cursor<Vec<u8>>

Trait Implementations

impl Debug for MockReader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MockReader

fn default() -> MockReader

Returns the “default value” for a type.

impl VMReader for MockReader

The implementation of the VMReader trait for the MockReader struct

fn read(&mut self) -> Result<u8>

Read a single byte from the mock reader

This function reads a single byte from the mock reader and returns it as a u8 for use by the VirtualMachine. The mock reader is implemented using a Cursor<Vec<u8>>, which is used to store the data that is read from the mock reader.

Errors

This function will return an error if the byte read from the mock reader is not within the ASCII range.

Examples

use brainfoamkit_lib::VMReader;

let mut mock = brainfoamkit_lib::MockReader {
    data: std::io::Cursor::new("A".as_bytes().to_vec()),
};

assert_eq!(mock.read().unwrap(), 65);
assert_eq!(
    mock.get_vmreader_type(),
    brainfoamkit_lib::VMReaderType::Mock
);

fn get_vmreader_type(&self) -> VMReaderType

Get the type of the reader