Struct jni::objects::AutoLocal
[−]
[src]
pub struct AutoLocal<'a> { /* fields omitted */ }
Auto-delete wrapper for local refs.
Anything passed to a foreign method is considered a local ref unless it's explicitly turned into a global. These refs are automatically deleted once the foreign method exits, but it's possible that they may reach the JVM-imposed limit before that happens.
This wrapper provides automatic local ref deletion when it goes out of scope.
NOTE: This comes with some potential safety risks. DO NOT use this to wrap something unless you're SURE it won't be used after this wrapper gets dropped. Otherwise, you'll get a nasty JVM crash.
Methods
impl<'a> AutoLocal<'a>
[src]
fn new(env: &'a JNIEnv<'a>, obj: JObject<'a>) -> Self
[src]
Creates a new auto-delete wrapper for a local ref.
Once this wrapper goes out of scope, the delete_local_ref
will be
called on the object. While wrapped, the object can be accessed via
the Deref
impl.
fn forget(self) -> JObject<'a>
[src]
Forget the wrapper, returning the original object.
This prevents delete_local_ref
from being called when the AutoLocal
gets
dropped. You must either remember to delete the local ref manually, or be
ok with it getting deleted once the foreign method returns.
fn as_obj<'b>(&'b self) -> JObject<'b> where
'a: 'b,
[src]
'a: 'b,
Get a reference to the wrapped object
Unlike forget
, this ensures the wrapper from being dropped while the
returned JObject
is still live.
Trait Implementations
impl<'a, 'b, 'c> Desc<'a, JClass<'b>> for &'b AutoLocal<'c> where
'c: 'b,
[src]
'c: 'b,
This conversion assumes that the AutoLocal
is a pointer to a class object.