Struct jni::Executor

source ·
pub struct Executor { /* private fields */ }
Expand description

Thread attachment manager. It allows to execute closures in attached threads with automatic local references management done with with_local_frame. It combines the performance benefits of permanent attaches whilst removing the risk of local references leaks if used consistently.

Although all locals are freed on closure exit, it might be needed to manually free locals inside the closure if an unbounded number of them is created (e.g., in a loop). See “Local Reference Management” for details.

Threads using the Executor are attached on the first invocation as daemons, hence they do not block JVM exit. Finished threads detach automatically.

Example


let exec = Executor::new(jvm);

let val: jint = exec.with_attached(|env| {
   let x = JValue::from(-10);
   env.call_static_method("java/lang/Math", "abs", "(I)I", &[x])?.i()
})?;

assert_eq!(val, 10);

Implementations§

source§

impl Executor

source

pub fn new(vm: Arc<JavaVM>) -> Self

Creates new Executor with specified JVM.

source

pub fn with_attached_capacity<F, T, E>( &self, capacity: i32, f: F ) -> Result<T, E>where F: FnOnce(&mut JNIEnv<'_>) -> Result<T, E>, E: From<Error>,

Executes a provided closure, making sure that the current thread is attached to the JVM. Additionally ensures that local object references are freed after call.

Allocates a local frame with the specified capacity.

source

pub fn with_attached<F, T, E>(&self, f: F) -> Result<T, E>where F: FnOnce(&mut JNIEnv<'_>) -> Result<T, E>, E: From<Error>,

Executes a provided closure, making sure that the current thread is attached to the JVM. Additionally ensures that local object references are freed after call.

Allocates a local frame with the default capacity.

Trait Implementations§

source§

impl Clone for Executor

source§

fn clone(&self) -> Executor

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.