Struct JObject

pub struct JObject<'local> { /* private fields */ }

Wrapper around [sys::jobject] that adds a lifetime to ensure that the underlying JNI pointer won’t be accessible to safe Rust code if the object reference is released.

It matches C’s representation of the raw pointer, so it can be used in any of the extern function argument positions that would take a jobject.

Most other types in the objects module deref to this, as they do in the C representation.

The lifetime 'local represents the local reference frame that this reference belongs to. See the [JNIEnv] documentation for more information about local reference frames. If 'local is 'static, then this reference does not belong to a local reference frame, that is, it is either null or a [global reference][GlobalRef].

Note that an owned JObject is always a local reference and will never have the 'static lifetime. [GlobalRef] does implement AsRef<JObject<’static>>, but this only yields a borrowed &JObject<'static>, never an owned JObject<'static>.

Local references belong to a single thread and are not safe to share across threads. This type implements Send and Sync if and only if the lifetime 'local is 'static.

Implementations

impl<'local> JObject<'local>

pub unsafe fn from_raw(raw: *mut _jobject) -> JObject<'local>

Creates a JObject that wraps the given raw jobject

Safety

raw may be a null pointer. If raw is not a null pointer, then:

• raw must be a valid raw JNI local reference.
• There must not be any other JObject representing the same local reference.
• The lifetime 'local must not outlive the local reference frame that the local reference was created in.

pub fn as_raw(&self) -> *mut _jobject

Returns the raw JNI pointer.

pub fn into_raw(self) -> *mut _jobject

Unwrap to the internal jni type.

pub fn null() -> JObject<'static>

Creates a new null reference.

Null references are always valid and do not belong to a local reference frame. Therefore, the returned JObject always has the 'static lifetime.

Trait Implementations

impl<'local> AsMut<JObject<'local>> for JObject<'local>

fn as_mut(&mut self) -> &mut JObject<'local>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'local> AsRef<JObject<'local>> for JClass<'local>

fn as_ref(&self) -> &JObject<'local>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'local> AsRef<JObject<'local>> for JObject<'local>

fn as_ref(&self) -> &JObject<'local>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'local> AsRef<JObject<'local>> for JObjectArray<'local>

fn as_ref(&self) -> &JObject<'local>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'local, T> AsRef<JObject<'local>> for JPrimitiveArray<'local, T>

where T: TypeArray,

fn as_ref(&self) -> &JObject<'local>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'local> AsRef<JObject<'local>> for JString<'local>

fn as_ref(&self) -> &JObject<'local>

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<JObject<'static>> for GlobalRef

fn as_ref(&self) -> &JObject<'static>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'local> Debug for JObject<'local>

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

Formats the value using the given formatter.

impl<'local> Default for JObject<'local>

fn default() -> JObject<'local>

Returns the “default value” for a type.

impl<'local> Deref for JObject<'local>

type Target = *mut _jobject

The resulting type after dereferencing.

fn deref(&self) -> &<JObject<'local> as Deref>::Target

Dereferences the value.

impl<'local, 'obj_ref> From<&'obj_ref JObject<'local>> for &'obj_ref JClass<'local>

This conversion assumes that the JObject is a pointer to a class object.

fn from(other: &'obj_ref JObject<'local>) -> &'obj_ref JClass<'local>

Converts to this type from the input type.

impl<'local, 'obj_ref> From<&'obj_ref JObject<'local>> for &'obj_ref JObjectArray<'local>

This conversion assumes that the JObject is a pointer to a class object.

fn from(other: &'obj_ref JObject<'local>) -> &'obj_ref JObjectArray<'local>

Converts to this type from the input type.

impl<'local, 'obj_ref, T> From<&'obj_ref JObject<'local>> for &'obj_ref JPrimitiveArray<'local, T>

where T: TypeArray,

This conversion assumes that the JObject is a pointer to a class object.

fn from( other: &'obj_ref JObject<'local>, ) -> &'obj_ref JPrimitiveArray<'local, T>

Converts to this type from the input type.

impl<'local, 'obj_ref> From<&'obj_ref JObject<'local>> for &'obj_ref JString<'local>

fn from(other: &'obj_ref JObject<'local>) -> &'obj_ref JString<'local>

Converts to this type from the input type.

impl<'local> From<JByteBuffer<'local>> for JObject<'local>

fn from(other: JByteBuffer<'_>) -> JObject<'_>

Converts to this type from the input type.

impl<'local> From<JClass<'local>> for JObject<'local>

fn from(other: JClass<'_>) -> JObject<'_>

Converts to this type from the input type.

impl<'local> From<JObject<'local>> for JClass<'local>

This conversion assumes that the JObject is a pointer to a class object.

fn from(other: JObject<'_>) -> JClass<'local>

Converts to this type from the input type.

impl<'local> From<JObject<'local>> for JObjectArray<'local>

This conversion assumes that the JObject is a pointer to a class object.

fn from(other: JObject<'_>) -> JObjectArray<'local>

Converts to this type from the input type.

impl<'local, T> From<JObject<'local>> for JPrimitiveArray<'local, T>

where T: TypeArray,

This conversion assumes that the JObject is a pointer to a class object.

fn from(other: JObject<'_>) -> JPrimitiveArray<'local, T>

Converts to this type from the input type.

impl<'local> From<JObject<'local>> for JString<'local>

fn from(other: JObject<'_>) -> JString<'local>

Converts to this type from the input type.

impl<'local> From<JObjectArray<'local>> for JObject<'local>

fn from(other: JObjectArray<'_>) -> JObject<'_>

Converts to this type from the input type.

impl<'local, T> From<JPrimitiveArray<'local, T>> for JObject<'local>

where T: TypeArray,

fn from(other: JPrimitiveArray<'local, T>) -> JObject<'local>

Converts to this type from the input type.

impl<'local> From<JString<'local>> for JObject<'local>

fn from(other: JString<'_>) -> JObject<'_>

Converts to this type from the input type.

impl<'local> From<JThrowable<'local>> for JObject<'local>

fn from(other: JThrowable<'_>) -> JObject<'_>

Converts to this type from the input type.

impl<T: FromStr> ParseJObjectType<T> for JObject<'_>

fn parse(&self, env: &mut JNIEnv<'_>) -> T

where <T as FromStr>::Err: Debug,

impl<'local> TryFrom<JValueGen<JObject<'local>>> for JObject<'local>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: JValueGen<JObject<'local>>) -> Result<JObject<'local>, Error>

Performs the conversion.

impl Send for JObject<'static>

impl Sync for JObject<'static>