rhasm

Crates.iorhasm
lib.rsrhasm
version0.2.0
sourcesrc
created_at2024-09-03 14:24:58.527313
updated_at2024-09-27 22:18:07.354013
descriptionA Rust implementation of the hasm assembler
homepage
repository
max_upload_size
id1361698
size221,514
Muaaz Bhyat (Muu79)

documentation

README

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> [-o | --output <output_file>] [-d | --disassemble [--with_symbols <symbol_file>]]

Library Examples

Code examples can be found in the crate's documentation

Commit count: 0

cargo fmt