v0.4.0 release

src/data/encoding.rs

@@ -72,7 +72,7 @@ pub enum EncodeError {
     /// string length is {0}, which exceeds 255 bytes limit
     StringTooLong(usize),
 
-    /// collection contains {0} items, which exceeds [`u18::MAX`] limit
+    /// collection contains {0} items, which exceeds [`u16::MAX`] limit
     ByteLimitExceeded(usize),
 
     /// collection contains {0} items, which exceeds [`u16::MAX`] limit

src/isa/asm.rs

@@ -17,9 +17,9 @@
 /// # extern crate alloc;
 /// # #[macro_use] extern crate aluvm;
 /// # use paste::paste;
-/// # use aluvm::{Vm};
+/// # use aluvm::Vm;
 /// # use aluvm::libs::Lib;
-/// # use aluvm::isa::ReservedOp;
+/// # use aluvm::isa::Instr;
 ///
 /// let code = aluasm! {
 ///         clr     r1024[5]                        ;
@@ -35,8 +35,8 @@
 ///         jmp     0                               ;
 /// };
 ///
-/// let lib = Lib::<ReservedOp>::assemble(&code).unwrap();
-/// let mut vm = Vm::with(lib);
+/// let lib = Lib::assemble(&code).unwrap();
+/// let mut vm = Vm::<Instr>::with(lib);
 /// match vm.main() {
 ///     true => println!("success"),
 ///     false => println!("failure"),

src/lib.rs

@@ -128,7 +128,7 @@ pub mod data;
 pub mod isa;
 pub mod libs;
 pub mod reg;
-mod vm;
+pub mod vm;
 
 pub use isa::Isa;
 pub use vm::Vm;

src/libs/segs.rs

@@ -28,10 +28,10 @@ use crate::libs::{LibId, LibSite};
 #[cfg_attr(feature = "std", derive(Error))]
 #[display(doc_comments)]
 pub enum SegmentError {
-    /// the size of the CODE segment is {0}, which exceeds [`CODE_SEGMENT_MAX_LEN`]
+    /// the size of the CODE segment is {0}, which exceeds `CODE_SEGMENT_MAX_LEN`
     CodeSegmentTooLarge(usize),
 
-    /// the size of the DATA segment is {0}, which exceeds [`DATA_SEGMENT_MAX_LEN`]
+    /// the size of the DATA segment is {0}, which exceeds `DATA_SEGMENT_MAX_LEN`
     DataSegmentTooLarge(usize),
 
     /// ISA segment error
@@ -254,7 +254,7 @@ impl LibSeg {
     ///
     /// # Errors
     ///
-    /// Checks requirement that the total number of libraries must not exceed [`LIBS_MAX_TOTAL`] and
+    /// Checks requirement that the total number of libraries must not exceed `LIBS_MAX_TOTAL` and
     /// returns [`LibSegOverflow`] otherwise
     ///
     /// # Returns