Struct ConfigurationBuilder 

pub struct ConfigurationBuilder { /* private fields */ }

Builder for creating a Configuration with a fluent interface.

This builder provides methods to set all the configuration options and then create a Configuration instance with the build() method.

Example

use ristretto_vm::ConfigurationBuilder;
use ristretto_classloader::ClassPath;

let config = ConfigurationBuilder::new()
    .class_path(ClassPath::from(&["."]))
    .main_class("com.example.Main")
    .java_version("21")
    .build()
    .unwrap();

Implementations

impl ConfigurationBuilder

pub fn new() -> Self

Creates a new ConfigurationBuilder with default values.

Default values include:

• No class path (will be set to “.” when building)
• No main class
• No JAR file
• No Java home
• Default Java version (will be set when building if no Java home is provided)
• Empty system properties
• JIT mode enabled
• Background batch compilation enabled
• Preview features disabled
• Verify mode set to Remote (verify only remote/untrusted classes)
• Standard output and error streams directed to system stdout/stderr

pub fn class_path(self, class_path: ClassPath) -> Self

Set the VM class path

pub fn main_class<S: AsRef<str>>(self, main_class: S) -> Self

Set the main class to run

pub fn jar(self, jar: PathBuf) -> Self

Set the jar

pub fn java_home(self, java_home: PathBuf) -> Self

Set the Java home path

pub fn java_version<S: AsRef<str>>(self, version: S) -> Self

Set the Java version

pub fn add_system_property<K, V>(self, key: K, value: V) -> Self

where K: AsRef<str>, V: AsRef<str>,

Add a system property

pub fn system_properties(self, properties: AHashMap<String, String>) -> Self

Set all system properties

pub fn interpreted(self, interpreted: bool) -> Self

Configure the VM to run in interpreted mode

pub fn batch_compilation(self, batch_compilation: bool) -> Self

Configure the VM to use background batch compilation

pub fn preview_features(self) -> Self

Enable preview features

pub fn verify_mode(self, verify_mode: VerifyMode) -> Self

Set the class verification mode

pub fn garbage_collector(self, garbage_collector: Arc<GarbageCollector>) -> Self

Set the garbage collector

If not set, the VM will create a default garbage collector.

pub fn module_path(self, paths: Vec<PathBuf>) -> Self

Set the module path (-p or –module-path)

pub fn add_module_path(self, path: impl Into<PathBuf>) -> Self

Add a path to the module path

pub fn upgrade_module_path(self, paths: Vec<PathBuf>) -> Self

Set the upgrade module path (–upgrade-module-path)

pub fn add_upgrade_module_path(self, path: impl Into<PathBuf>) -> Self

Add a path to the upgrade module path

pub fn main_module(self, main_module: MainModule) -> Self

Set the main module (–module or -m)

pub fn set_add_modules(self, modules: Vec<String>) -> Self

Set the additional modules to add (–add-modules)

pub fn add_module(self, module: impl Into<String>) -> Self

Add a module to the additional modules list (–add-modules)

pub fn set_limit_modules(self, modules: AHashSet<String>) -> Self

Set the modules to limit observability (–limit-modules)

pub fn limit_module(self, module: impl Into<String>) -> Self

Add a module to the limit modules set (–limit-modules)

pub fn set_add_reads(self, reads: Vec<ModuleRead>) -> Self

Set the read edges to add (–add-reads)

pub fn add_read(self, read: ModuleRead) -> Self

Add a read edge (–add-reads)

pub fn set_add_exports(self, exports: Vec<ModuleExport>) -> Self

Set the exports to add (–add-exports)

pub fn add_export(self, export: ModuleExport) -> Self

Add an export (–add-exports)

pub fn set_add_opens(self, opens: Vec<ModuleOpens>) -> Self

Set the opens to add (–add-opens)

pub fn add_opens(self, opens: ModuleOpens) -> Self

Add an opens directive (–add-opens)

pub fn set_patch_modules(self, patches: Vec<ModulePatch>) -> Self

Set the patch modules (–patch-module)

pub fn add_patch(self, patch: ModulePatch) -> Self

Add a patch module (–patch-module)

pub fn stdin(self, stdin: Arc<Mutex<dyn Read + Send + Sync>>) -> Self

Set the standard input stream

pub fn stdout(self, stdout: Arc<Mutex<dyn Write + Send + Sync>>) -> Self

Set the standard output stream

pub fn stderr(self, stderr: Arc<Mutex<dyn Write + Send + Sync>>) -> Self

Set the standard error stream

pub fn build(self) -> Result<Configuration>

Build the configuration

Errors

An error will be returned if:

• Both Java home and Java version are specified (mutually exclusive)

Trait Implementations

impl Debug for ConfigurationBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ConfigurationBuilder

fn default() -> Self

Returns the “default value” for a type.