Struct java_spaghetti::Local

pub struct Local<'env, T: ReferenceType> { /* private fields */ }

A Local, non-null, reference to a Java object (+ Env) limited to the current thread/stack.

Including the env allows for the convenient execution of methods without having to individually pass the env as an argument to each and every one. Since this is limited to the current thread/stack, these cannot be sanely stored in any kind of static storage, nor shared between threads - instead use a Global if you need to do either.

Will DeleteLocalRef when dropped, invalidating the jobject but ensuring threads that rarely or never return to Java may run without being guaranteed to eventually exhaust their local reference limit. If this is not desired, convert to a plain Ref with:

let local = Local::leak(local);

Not FFI Safe: #[repr(rust)], and exact layout is likely to change - depending on exact features used - in the future. Specifically, on Android, since we’re guaranteed to only have a single ambient VM, we can likely store the *const JNIEnv in thread local storage instead of lugging it around in every Local. Of course, there’s no guarantee that’s actually an optimization…

Implementations

impl<'env, T: ReferenceType> Local<'env, T>

pub unsafe fn from_raw(env: Env<'env>, object: jobject) -> Self

pub fn env(&self) -> Env<'env>

pub fn as_raw(&self) -> jobject

pub fn into_raw(self) -> jobject

pub fn leak(self) -> Ref<'env, T>

pub fn as_global(&self) -> Global<T>

pub fn as_ref(&self) -> Ref<'_, T>

pub fn as_return(&self) -> Return<'env, T>

pub fn into_return(self) -> Return<'env, T>

pub fn cast<U: ReferenceType>(&self) -> Result<Local<'env, U>, CastError>

pub fn upcast<U: ReferenceType>(&self) -> Local<'env, U>

where Self: AssignableTo<U>,

Trait Implementations

impl<T: ReferenceType, U: AssignableTo<T>> AsArg<T> for Local<'_, U>

fn as_arg(&self) -> jobject

fn as_arg_jvalue(&self) -> jvalue

impl<'env, T: ReferenceType> Clone for Local<'env, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'env, T: ReferenceType + Debug> Debug for Local<'env, T>

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

Formats the value using the given formatter.

impl<'env, T: ReferenceType> Deref for Local<'env, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'env, T: ReferenceType + Display> Display for Local<'env, T>

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

Formats the value using the given formatter.

impl<'env, T: ReferenceType> Drop for Local<'env, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'env, T: ReferenceType> From<&Local<'env, T>> for Global<T>

fn from(x: &Local<'env, T>) -> Self

Converts to this type from the input type.

impl<'env, T: ReferenceType> From<&Local<'env, T>> for Local<'env, T>

fn from(x: &Local<'env, T>) -> Self

Converts to this type from the input type.

impl<'env, T: ReferenceType> From<&Ref<'env, T>> for Local<'env, T>

fn from(x: &Ref<'env, T>) -> Self

Converts to this type from the input type.

impl<'env, T: ReferenceType> From<Local<'env, T>> for Global<T>

fn from(x: Local<'env, T>) -> Self

Converts to this type from the input type.

impl<'env, T: ReferenceType> From<Ref<'env, T>> for Local<'env, T>

fn from(x: Ref<'env, T>) -> Self

Converts to this type from the input type.