Struct Binary

pub struct Binary { /* private fields */ }

A Chip-8 binary

Implementations

impl Binary

pub fn new(new_name: &str) -> Result<Binary, BinaryError>

Constructs a new Binary instance

Argument

• new_name - The name of the binary file

Returns

A new Binary instance, wrapped in a Result

pub fn len(&self) -> u16

Gets the length of the binary

Returns

The length of the binary (in bytes)

pub fn add_instruction( &mut self, instr: &Instruction, ) -> Result<(), BinaryError>

Adds an instruction to the binary

Argument

• instr - The Instruction to add

Returns

Ok if the instruction was added successfully, Err<BinaryError> if the operation fails

pub fn add_word(&mut self, word: u16) -> Result<(), BinaryError>

Adds a 16-bit word to the binary

Argument

• word - The word to add

Returns

Ok if the word was written successfully, Err<BinaryError> if the operation fails

pub fn add_byte(&mut self, byte: u8) -> Result<(), BinaryError>

Adds a byte to the binary

Argument

• byte - The byte to add

Returns

Ok if the byte was written successfully, Err<BinaryError> if the operation fails

pub fn write_to_file(&mut self) -> Result<usize, BinaryError>

Writes the entire binary to a file

Returns

A Result that on a success contains the number of bytes written, and that on a failure contains a BinaryError object

Panics

This method will panic if the binary file handle fails to be created successfully.