RHASM (Rust Hack Assembler)

This is a simple assembler for the Hack assembly language, written in Rust. The assembler can be used as a cli tool or as a library in your Rust project. Rhasm requires the input file to be a valid Hack assembly file, and it will output a Hack machine code file. The assembler supports all Hack assembly instructions, including A-instructions, C-instructions, and L-instructions. An example of a valid Hack assembly file is included as sample.asm.

Installation

As a CLI tool

To install the cli tool make sure cargo is installed (you can install cargo from here), then run the following command:

cargo install rhasm

As a library

To use the library in your project, add the following to your Cargo.toml:

[dependencies]
rhasm = "0.1.0"

Or you can use cargo to add the dependency:

cargo add rhasm

Then import the library in your project:

use rhasm;

let asm = rhasm::Assembler::build(&in_file, &out_file);
// Then you can use the asm object to assemble the file

Usage

Rhasm exposes two ways to assemble Hack assembly code, the first is through a binary cli tool and the second is through a library.

CLI Example

To use rhasm as a cli tool, you can run the following command:

rhasm <input_file> <output_file>

Library Example

As a library, rhasm exposes an Assembler struct that can be used to assemble Hack assembly code.

To use rhasm as a library, you can use the following code:

use rhasm;
use std::fs::File;

let in_file = File::open("path/to/input/file.asm").unwrap();
let out_file = File::create("path/to/output/file.hack").unwrap();

let asm = rhasm::Assembler::build(&in_file, &out_file);
asm.advance_once() // encodes and immediately writes the next instruction
asm.advance_to_end() // encodes and writes all remaining instructions

Alternatively, you can use the get_next_encoded_instruction method to get the next encoded instruction without writing it to the output file:

use rhasm;
use std::fs::File;

let in_file = File::open("path/to/input/file.asm").unwrap();
let out_file = File::create("path/to/output/file.hack").unwrap();

let mut asm = rhasm::Assembler::build(&in_file, &out_file);
while let Some(encoded_instruction) = asm.get_next_encoded_instruction() {
    // Do something with the encoded instruction
}