Struct InitArguments

pub struct InitArguments { /* private fields */ }

Arguments for creating a Java VM.

JNI documentation

Example

use rust_jni::{InitArguments, JniVersion, JvmOption, JvmVerboseOption};

let options = InitArguments::get_default(JniVersion::V8).unwrap()
    .with_option(JvmOption::Unknown("-Xgc:parallel".to_owned()))
    .with_option(JvmOption::Verbose(JvmVerboseOption::Gc));

assert_eq!(options.version(), JniVersion::V8);

Implementations

impl InitArguments

pub fn get_default(version: JniVersion) -> Option<Self>

Get default Java VM init arguments for a JNI version. If the requested JNI version is not supported, returns None.

JNI documentation

pub fn get_default_or_closest_supported(version: JniVersion) -> Self

Get default Java VM init arguments for a JNI version. If the requested JNI version is not supported, returns default arguments for the closest supported JNI version. The new version can be obtained with the InitArguments::version() method.

JNI documentation

pub fn get_latest_default() -> Self

Get default init arguments for the latest supported JNI version.

JNI documentation

pub fn with_options(self, options: &[JvmOption]) -> Self

Add init options to the Java VM init arguments.

JNI documentation

pub fn with_option(self, option: JvmOption) -> Self

Add an init option to the Java VM init arguments.

JNI documentation

pub fn unchecked(self) -> Self

Disable checking JNI calls for correctness.

pub fn checked(self) -> Self

Enable checking JNI calls for correctness.

This is a default. Only needed to be called if checking JNI calls was explicitly disabled.

pub fn ignore_unrecognized_options(self) -> Self

Request for JVM to ignore unrecognized options on startup.

JNI documentation

pub fn fail_on_unrecognized_options(self) -> Self

Request for JVM to fail in presence of unrecognized options on startup.

JNI documentation

pub fn version(&self) -> JniVersion

Return the JNI version these arguments will request when creating a Java VM.

JNI documentation

Trait Implementations

impl Clone for InitArguments

fn clone(&self) -> InitArguments

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InitArguments

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

Formats the value using the given formatter.

impl PartialEq for InitArguments

fn eq(&self, other: &InitArguments) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for InitArguments

impl StructuralPartialEq for InitArguments