ristretto_vm 0.20.0

Java Virtual Machine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

//! # Ristretto VM
//!
//! [![Code Coverage](https://codecov.io/gh/theseus-rs/ristretto/branch/main/graph/badge.svg)](https://codecov.io/gh/theseus-rs/ristretto)
//! [![Benchmarks](https://img.shields.io/badge/%F0%9F%90%B0_bencher-enabled-6ec241)](https://bencher.dev/perf/theseus-rs-ristretto)
//! [![License](https://img.shields.io/crates/l/ristretto_vm)](https://github.com/theseus-rs/ristretto#license)
//! [![Semantic Versioning](https://img.shields.io/badge/%E2%9A%99%EF%B8%8F_SemVer-2.0.0-blue)](https://semver.org/spec/v2.0.0.html)
//!
//! Ristretto VM is a Java Virtual Machine implementation written in pure Rust. It executes Java
//! bytecode by interpreting class files loaded through the Ristretto classloader.
//!
//! ## Features
//!
//! - Bytecode interpretation with no dependencies on existing JVM implementations
//! - Pure Rust implementation for memory safety and performance
//! - Support for Java class loading and execution
//! - Configurable VM parameters
//! - Basic JIT compilation capabilities
//!
//! ## Example
//!
//! ```rust,no_run
//! use ristretto_vm::{VM, Configuration, ConfigurationBuilder};
//! use ristretto_classloader::ClassPath;
//!
//! // Create a VM configuration
//! let configuration = ConfigurationBuilder::new()
//!     .class_path("/path/to/classes".into())
//!     .build()?;
//!
//! // Create the VM instance
//! let mut vm = VM::new(configuration)?;
//!
//! // Execute main method of a class
//! vm.execute_main("com.example.Main", vec![])?;
//! # Ok::<(), ristretto_classfile::Error>(())
//! ```
//!
//! ## Safety
//!
//! This crate uses `#![forbid(unsafe_code)]` to ensure everything is implemented in 100% safe Rust.

#![forbid(unsafe_code)]
#![forbid(clippy::allow_attributes)]
#![allow(dead_code)]
#![allow(clippy::only_used_in_recursion)]
// Disable pedantic clippy lint due to error when running clippy on this crate
// cargo clippyerror: allocating a local array larger than 16384 bytes
//    |
//    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#large_stack_arrays
// note: the lint level is defined here
//   --> ristretto_vm/src/lib.rs:25:9
//    |
// 25 | #![deny(clippy::pedantic)]
//    |         ^^^^^^^^^^^^^^^^
//    = note: `#[deny(clippy::large_stack_arrays)]` implied by `#[deny(clippy::pedantic)]`
// #![deny(clippy::pedantic)]
#![deny(clippy::unwrap_in_result)]
#![deny(clippy::unwrap_used)]
mod configuration;
mod error;
mod frame;
mod instruction;
mod intrinsic_methods;
mod java_error;
mod java_object;
mod jit;
mod local_variables;
mod operand_stack;
mod parameters;
mod rust_value;
#[cfg(test)]
pub(crate) mod test;
mod thread;
mod vm;

pub use configuration::{Configuration, ConfigurationBuilder};
pub use error::{Error, Result};
pub(crate) use frame::Frame;
pub use java_error::JavaError;
pub use java_object::JavaObject;
pub(crate) use local_variables::LocalVariables;
pub(crate) use operand_stack::OperandStack;
pub use ristretto_classloader::{Class, ClassPath, DEFAULT_JAVA_VERSION, Reference, Value};
pub(crate) use thread::Thread;
pub use vm::VM;