Skip to content

Update Rust crate jni to 0.21 #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Rust crate jni to 0.21 #20

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Feb 14, 2023

This PR contains the following updates:

Package Type Update Change
jni dependencies minor 0.20 -> 0.21

Release Notes

jni-rs/jni-rs (jni)

v0.21.1

Compare Source

Fixes
  • Compilation is fixed for architectures with a C ABI that has unsigned char types. (#​419)

v0.21.0

Compare Source

This release makes extensive breaking changes in order to improve safety. Most projects that use this library will need to be changed. Please see the migration guide.

Added
  • JavaStr::into_raw() which drops the JavaStr and releases ownership of the raw string pointer (#​374)
  • JavaStr::from_raw() which takes ownership of a raw string pointer to create a JavaStr (#​374)
  • JNIEnv::get_string_unchecked is a cheaper, unsafe alternative to get_string that doesn't check the given object is a java.lang.String instance. (#​328)
  • WeakRef and JNIEnv#new_weak_ref. (#​304)
  • define_class_bytearray method that takes an AutoElements<jbyte> rather than a &[u8] (#​244)
  • JObject now has an as_raw method that borrows the JObject instead of taking ownership like into_raw. Needed because JObject no longer has the Copy trait. (#​392)
  • JavaVM::destroy() (unsafe) as a way to try and unload a JavaVM on supported platforms (#​391)
  • JavaVM::detach_current_thread() (unsafe) as a way to explicitly detach a thread (normally this is automatic on thread exit). Needed to detach daemon threads manually if using JavaVM::destroy() (#​391)
  • JPrimitiveArray<T: TypeArray> and type-specific aliases like JByteArray, JIntArray etc now provide safe, reference wrappers for the sys types jarray and jbyteArray etc with a lifetime like JObject (#​400)
  • JObjectArray provides a reference wrapper for a jobjectArray with a lifetime like JObject. (#​400)
  • AutoElements and AutoElementsCritical (previously AutoArray/AutoPrimitiveArray) implement Deref<Target=[T]> and DerefMut so array elements can be accessed via slices without needing additional unsafe code. (#​400)
  • AsJArrayRaw trait which enables JNIEnv::get_array_length() to work with JPrimitiveArray or JObjectArray types (#​400)
  • InitArgsBuilder now has try_option and option_encoded methods. (#​414)
Changed
  • JNIEnv::get_string checks that the given object is a java.lang.String instance to avoid undefined behaviour from the JNI implementation potentially aborting the program. (#​328)
  • JNIEnv::call_*method_unchecked was marked unsafe, as passing improper argument types, or a bad number of arguments, can cause a JVM crash. (#​385)
  • The JNIEnv::new_object_unchecked function now takes arguments as &[jni::sys::jvalue] to avoid allocating, putting it inline with changes to JniEnv::call_*_unchecked from 0.20.0 (#​382)
  • The get_superclass function now returns an Option instead of a null pointer if the class has no superclass (#​151)
  • The invocation feature now locates the JVM implementation dynamically at runtime (via the java-locator crate by default) instead of linking with the JVM at build time (#​293)
  • Most JNIEnv methods now require &mut self. This improves safety by preventing JObjects from getting an invalid lifetime. Most native method implementations (that is, #[no_mangle] extern "system" fns) must now make the JNIEnv parameter mut. See the example on the crate documentation. (#​392)
  • JByteBuffer, JClass, JNIEnv, JObject, JString, and JThrowable no longer have the Clone or Copy traits. This improves safety by preventing object references from being used after the JVM deletes them. Most functions that take one of these types as a parameter (except extern fns that are directly called by the JVM) should now borrow it instead, e.g. &JObject instead of JObject. (#​392)
  • AutoLocal is now generic in the type of object reference (JString, etc). (#​392)
  • The closure passed to JNIEnv::with_local_frame must now take a &mut JNIEnv parameter, which has a different lifetime. This improves safety by preventing local references from escaping the closure, which would cause a use-after-free bug. Executor::with_attached and Executor::with_attached_capacity have been similarly changed. (#​392)
  • The closure passed to JNIEnv::with_local_frame can now return a generic Result<T, E> so long as the error implements From<jni::errors::Error> (#​399)
  • JNIEnv::with_local_frame now returns the same type that the given closure returns (#​399)
  • JNIEnv::with_local_frame no longer supports returning a local reference directly to the calling scope (see with_local_frame_returning_local) (#​399)
  • Executor::with_attached and Executor::with_attached_capacity have been changed in the same way as JNIEnv::with_local_frame (they are thin wrappers) (#​399)
  • Desc, JNIEnv::pop_local_frame, and TypeArray are now unsafe. (#​392)
  • The Desc trait now has an associated type Output. Many implementations now return AutoLocal, so if you call Desc::lookup yourself and then call as_raw on the returned object, make sure the AutoLocal isn't dropped too soon (see the Desc::lookup documentation for examples). (#​392)
  • The Desc<JClass> trait is no longer implemented for JObject or &JObject. The previous implementation that called .get_object_class() was surprising and a simpler cast would make it easy to mistakenly pass instances where a class is required. (#​118)
  • Named lifetimes in the documentation have more descriptive names (like 'local instead of 'a). The new naming convention is explained in the JNIEnv documentation. (#​392)
  • Object reference types (JObject, JClass, AutoLocal, GlobalRef, etc) now implement AsRef<JObject> and Deref<Target = JObject>. Typed wrappers like JClass also implement Into<JObject>, but GlobalRef does not. (#​392)
  • Most JList and JMap methods now require a &mut JNIEnv parameter. JListIter and JMapIter no longer implement Iterator, and instead have a next method that requires a &mut JNIEnv parameter (use while let loops instead of for). (#​392)
  • JValue has been changed in several ways: (#​392)
    • It is now a generic type named JValueGen. JValue is now a type alias for JValueGen<&JObject>, that is, it borrows an object reference. JValueOwned is a type alias for JValueGen<JObject>, that is, it owns an object reference.
    • JValueOwned does not have the Copy trait.
    • The to_jni method is now named as_jni, and it borrows the JValueGen instead of taking ownership.
    • JObject can no longer be converted directly to JValue, which was commonly done when calling Java methods or constructors. Instead of obj.into(), use (&obj).into().
  • All JNIEnv array APIs now work in terms of JPrimitiveArray and JObjectArray (reference wrappers with a lifetime) instead of sys types like jarray and jbyteArray (#​400)
  • AutoArray and AutoPrimitiveArray have been renamed AutoElements and AutoElementsCritical to show their connection and differentiate from new JPrimitiveArray API (#​400)
  • get_primitive_array_critical is now unsafe and has been renamed to get_array_elements_critical (consistent with the rename of AutoPrimitiveArray) with more detailed safety documentation (#​400)
  • get_array_elements is now also unsafe (for many of the same reasons as get_array_elements_critical) and has detailed safety documentation (#​400)
  • AutoArray/AutoArrayCritical::size() has been replaced with .len() which can't fail and returns a usize (#​400)
  • The TypeArray trait is now a private / sealed trait, that is considered to be an implementation detail for the AutoArray API.
  • JvmError has several more variants and is now non_exhaustive. (#​414)
  • InitArgsBuilder::option raises an error on Windows if the string is too long. The limit is currently 1048576 bytes. (#​414)
Fixed
  • Trying to use an object reference after it has been deleted now causes a compile error instead of undefined behavior. As a result, it is now safe to use AutoLocal, JNIEnv::delete_local_ref, and JNIEnv::with_local_frame. (Most of the limitations added in #​392, listed above, were needed to make this work.) (#​381, #​392)
  • Class lookups via the Desc trait now return AutoLocals, which prevents them from leaking. (#​109, #​392)
  • InitArgsBuilder::option properly encodes non-ASCII characters on Windows. (#​414)
Removed
  • get_string_utf_chars and release_string_utf_chars from JNIEnv (See JavaStr::into_raw() and JavaStr::from_raw() instead) (#​372)
  • All JNIEnv::get_<type>_array_elements() methods have been removed as redundant since they would all be equivalent to get_array_elements() with the introduction of JPrimitiveArray (#​400)

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot force-pushed the renovate/jni-0.x branch from 8e5892c to 99e6070 Compare February 18, 2023 12:23
@renovate renovate bot force-pushed the renovate/jni-0.x branch 4 times, most recently from 60da5ec to a08fdba Compare March 16, 2023 03:05
@renovate renovate bot force-pushed the renovate/jni-0.x branch from 41567e6 to d44206f Compare March 24, 2023 07:13
@renovate renovate bot force-pushed the renovate/jni-0.x branch 2 times, most recently from 6e74ab9 to 7abec01 Compare April 13, 2023 22:03
@renovate renovate bot force-pushed the renovate/jni-0.x branch from 7abec01 to 81c5caa Compare June 9, 2023 19:04
@renovate renovate bot force-pushed the renovate/jni-0.x branch from 81c5caa to fce47fb Compare August 9, 2023 18:11
@renovate renovate bot force-pushed the renovate/jni-0.x branch from 2dc66bc to 6cb1a15 Compare August 24, 2023 16:34
@renovate renovate bot force-pushed the renovate/jni-0.x branch from 6cb1a15 to f9618ea Compare September 4, 2023 17:07
@renovate renovate bot force-pushed the renovate/jni-0.x branch from f9618ea to fa0f598 Compare September 22, 2023 22:52
@renovate renovate bot force-pushed the renovate/jni-0.x branch from fa0f598 to a74c94c Compare October 17, 2023 19:21
@renovate renovate bot force-pushed the renovate/jni-0.x branch 2 times, most recently from 55fb0ce to 663c144 Compare February 3, 2024 22:26
@renovate renovate bot force-pushed the renovate/jni-0.x branch 2 times, most recently from a8e668f to 9f2bd2c Compare April 25, 2024 19:38
@renovate renovate bot force-pushed the renovate/jni-0.x branch from 9f2bd2c to 1c525b2 Compare May 1, 2024 09:53
@renovate renovate bot changed the title Update Rust crate jni to 0.21 Update Rust crate jni to 0.21.1 May 1, 2024
@renovate renovate bot changed the title Update Rust crate jni to 0.21.1 Update Rust crate jni to 0.21 May 5, 2024
@renovate renovate bot force-pushed the renovate/jni-0.x branch 2 times, most recently from 64b277c to 9b12c95 Compare May 9, 2024 01:29
@renovate renovate bot force-pushed the renovate/jni-0.x branch from 9b12c95 to a0ea96e Compare May 17, 2024 03:36
@renovate renovate bot force-pushed the renovate/jni-0.x branch from a0ea96e to db9b345 Compare June 13, 2024 01:00
@renovate renovate bot force-pushed the renovate/jni-0.x branch 2 times, most recently from 8f5cb52 to 2d1fe60 Compare September 26, 2024 21:40
@renovate renovate bot force-pushed the renovate/jni-0.x branch from 2d1fe60 to ec471d6 Compare October 7, 2024 21:20
@renovate renovate bot force-pushed the renovate/jni-0.x branch from ec471d6 to e99a32a Compare October 23, 2024 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants