Documentation

Guides for embedding asm-rs: installation, the assembler API, syntax dialects, directives, resource limits and the internal architecture.

asm-rs assembles text into machine code for six targets behind one API. These pages cover how to drive it, what it accepts, and how it works inside.

New here? Start with the Getting Started guide, then keep Configuration open — it is the reference for syntax dialects, directives and limits.

For the generated Rust API — every type, method and doc-test — see docs.rs/asm-rs.

Install asm-rs and assemble your first machine code — one-shot API, builder API, labels, and compile-time macros.

Cargo features, optimization levels, syntax dialects, directives, resource limits, shifted operands and branch alignment rules.

How the asm-rs API is shaped: one-shot functions, the Assembler builder, AssemblyResult, error handling and the compile-time macros.

How asm-rs works inside: the preprocessor, lexer, parser, IR, optimizer, per-architecture encoders and the fragment-based linker.