Update Rust crate jni to 0.22 #235
No reviewers
Labels
No labels
bug
documentation
duplicate
enhancement
good first issue
help wanted
invalid
major version
merge when passing
minor version
patch version
question
wontfix
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
Templates/Rust-Multi-Platform-Project!235
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "renovate/jni-0.x"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
This PR contains the following updates:
0.21->0.22Release Notes
jni-rs/jni-rs (jni)
v0.22.0Compare Source
Added
JavaVM / Thread Attachment APIs
JavaVM::singleton()lets you acquire theJavaVMfor the process when you know that theJavaVMsingleton has been initialized (#595)JavaVM::is_thread_attachedcan query whether the current thread is attached to the Java VM (#570)AttachGuard::from_unownedadded as a low-level (unsafe) way to represent a thread attachment with a rawjni_sys::Envpointer (#570)AttachConfigexposes fine-grained control over thread attachment includingThreadname,ThreadGroupand whether scoped or permanent. (#606)JavaVM::attach_current_thread_guardis a low-level (unsafe) building block for attaching threads that exposes theAttachGuardandAttachConfigcontrol. (#606)JavaVM::attach_current_thread_with_configis a safe building block for attaching threads that hides theAttachGuardbut exposesAttachConfigcontrol. (#606)JavaVM::with_local_frameadded as method to borrow aEnvthat is already attached to the current thread, after pushing a new JNI stack frame (#570, #673)JavaVM::with_top_local_frame_frameadded to borrow aEnvfor the top JNI stack frame (i.e. without pushing a new JNI stack frame) (#570, #673)Reference Type APIs
Referencetrait for all reference types likeJObject,JClass,JString, enablingGlobalandWeakto be generic overReferenceand enabling safe casting and global caching ofJClassreferences. (#596)Reference::lookup_classexposes a cachedGlobal<JClass>for allReferenceimplementations (#612)LoaderContext+LoaderContext::load_classfor loading classes, depending on available context (#612)Env::new_cast_global_refacts likenew_global_refwith a type cast (#612)Env::cast_globaltakes an ownedGlobal<From>and returns an ownedGlobal<To>(#612)Env::new_cast_local_refacts likenew_local_refwith a type cast (#612)Env::cast_localtakes an owned local reference and returns a new type-cast wrapper (owned) (#612)Env::as_castorCast::newborrows anyFrom: Reference(global or local) reference and returns aCast<To>that will Deref into&To(#612)Env::as_cast_uncheckedreturns aCast<To>likeas_cast()but without a runtimeIsInstanceOfcheck (#669)Env::as_cast_raworCast::from_rawborrows a rawjobjectreference and returns aCast<To>that will Deref into&ToCast::new_uncheckedandCast::from_raw_uncheckedlet you borrow a reference with an (unsafe) type cast, with no runtime check::cast_local()methods as a convenience for all reference types, such aslet s = JString::cast_local(obj)constnull()methods for all reference types.Global::null()andWeak::null()construct null references (equivalent toDefault::default()). (#596)JNI Environment APIs
Env::call_nonvirtual_methodandEnv::call_nonvirtual_method_uncheckedto call non-virtual method. (#454)Env::to_reflected_methodandEnv::to_reflected_static_methodfor retrieving the Java reflection API instance for a method or constructor. (#579)Env::throw_new_voidprovides an easy way to throw an exception that's constructed with no message argumentEnv::new_object_type_array<E>lets you you instantiate aJObjectArraywith a given element type likenew_object_type_array::<JString>Env::load_classsupports class lookups via the currentThreadcontext class loader, withFindClassfallback. (#674)MethodSignatureandFieldSignaturetypes have been added for compile-time parsed JNI method and field signaturesNative Method APIs
EnvUnownedis an FFI-safe type that can be used to capture ajni_sys::Envpointer given to native methods and give it a named lifetime (this can then be temporarily upgraded to a&mut Envreference viaEnvUnowned::with_env) (#570)Outcomeis like aResultwith the addition of a thirdPanic()variant, used for careful handling of errors in native methods. (#664)EnvOutcomerepresents anEnvUnowned::with_envoutcome whose errors can be handle, with access to JNI, via anErrorPolicy. (#664)ErrorPolicyis a trait withon_errorandon_panicmethods that can log native method errors or throw them as exceptions. (#664)ThrowRuntimeExAndDefaultis anErrorPolicythat throws any error as aRuntimeException(and returns a default value). (#664)LogErrorAndDefaultis anErrorPolicythat logs errors and returns a default value. (#664)LogContextErrorAndDefaultis anErrorPolicythat logs errors, with a given context string, and returns a default value. (#664)String APIs
New functions for converting Rust
charto and from Javacharandint(#427 / #434)JavaStr/MUTF8Chars,JNIStr, andJNIStringhave several new methods and traits, most notably ato_strmethod that converts to a regular Rust string. (#510 / #512)JNIStrnow implementsDebug,PartialEq,Eq,PartialOrd,OrdandHash(#615)JNIStringnow implementsDebug,PartialEq,Eq,PartialOrd,Ord,HashandClone(#615)PartialEq<&JNIStr> for JNIStringallowsJNIStrandJNIStringto be compared. (#615)From<&JNIStr>andFrom<MUTF8Chars>implementations forJNIString. (#615)JNIStr::from_cstrsafely does a zero-copy cast of aCStrto aJNIStrafter aconstmodified-utf8 encoding validation (#615,#617, #715)JNIStr::to_bytesgives access to a&[u8]slice over the bytes of a JNI string (likeCStr::to_bytes) (#615)java.lang APIs
JClassLoaderas aReferencewrapper forjava.lang.ClassLoaderreferences (#612)JCollection,JSetandJIteratorreference wrappers forjava.util.Collection,java.util.Setandjava.util.Iteratorinterfaces. (#621)JList::remove_itemfor removing a given value, by-reference, from the list (instead of by index). (#713)JList::clearallows a list to be cleared. (#713)JList::is_emptychecks if a list is empty. (#713)JList::as_collectioncasts a list into aJCollection(#713)JObjectArray::newlets you construct aJObjectArray<E>with strong element type parameterization, instead ofEnv::new_object_array(#657 + #688)JObjectArray::get/set_elementlet you get and set array elements as methods on the array. (#654)JPrimitiveArray::newlets you construct aJPrimitiveArray<E>, consistent withJObjectArray::new(#688)JStackTraceElementgives access to stack frame info within a stack trace, like filename, line number etc (#657)JStringnow has::new(),::from_strand::from_jni_strconstructor methods (#960)JThreadas aReferencewrapper forjava.lang.Threadreferences (#612)JThrowable::get_messageis a binding forgetMessage()and gives easy access to an exception messageJThrowable::get_stack_traceis a binding forgetStackTrace(), returning aJObjectArray<JStackTraceElement>Macros
#[jni_mangle()]attribute proc macro can export anextern "system"native method with a mangled name like "Java_com_example_myMethod" so it can be automatically resolved within a shared library by the JVM (#693)jni_str!andjni_cstr!macros can encode a MUTF-8&'static JNIStror&' static CStrat compile time with full unicode support. (#696)jni_sig!,jni_sig_str!,jni_sig_cstr!andjni_sig_jstr!macros can parse and compile signatures like(arg0: jint, arg1: JString) -> JStringintoMethodSignatureandFieldSignaturedescriptors or JNI string literals like "(ILjava/lang/String;)Ljava/lang/String;" (#697)native_method!macro binds a single native method to a Rust function with type safety and optionally exports it too. (#698)bind_java_type!macro can generate full Rust bindings for Java types (classes and interfaces) with fields, constructors, methods and native methods (#712)Changed
JavaVM / Thread Attachment APIs
>= 1.4. It needs>= 1.2so it can check for exceptions and needs>= 1.4to avoid runtime checks for direct byte buffers (#478)AttachGuardAttachGuardusage is now consideredunsafesince the type must be pinned to the stack (but that can't be guaranteed by the Rust type system alone).AttachGuardis pinned to the stack), attachment APIs take aFnOncewhose&mut Envarg borrows from a hiddenAttachGuardJavaVM::attach_current_threadrequests a permanent thread attachment (reducing cost of futureattach_current_thread()calls)JavaVM::attach_current_thread_for_scoperequests a thread attachment that's detached after the given closure returns.JavaVM::get_java_vm_pointerhas been renamedJavaVM::get_rawfor consistency.JavaVM::newandJavaVM::with_libjvmnow prevent libjvm from being unloaded. This isn't necessary for HotSpot, but other JVMs could crash if we don't do this. (#554)Reference and Primitive Types
Make
from_raw(),into_raw()andnull()methodsconst fn. (#453)Make
from_raw()require anEnvreference so the returned wrapper is guaranteed to have a local reference frame lifetime (#670)GlobalRefandWeakRefhave been renamed toGlobalandWeakand are now generic, parameterized, transparent wrappers over'staticreference types likeGlobal<JClass<'static>>(no longer anArcholding a reference and VM pointer) (#596)GlobalandWeakno longer implementClone, since JNI is required to create new reference (you'll need to explicitly useenv.new_global_ref)GlobalandWeakboth implementDefault, which will represent::null()references (equivalent toJObject::null())Global::into_rawreplacesGlobal::try_into_rawand is infallible (#596)AutoLocalhas been renamed toAutowith a deprecated type alias forAutoLocalto sign post the rename.AutoElementswas simplified to only be parameterized by one lifetime for the array reference, and accepts anyAsRef<JPrimitiveArray<T>>as a reference. (#508)JObjectArraysupports generic element types likeJObjectArray<JString>JavaTypewas simplified to not capture object names or array details (likeReturnType) since these details don't affectJValuetype checks and had a hidden cost that was redundant.JValueGenhas been removed.JValueandJValueOwnedare now separate, unrelated, non-generic types.(#429) (Note: previously
JValueandJValueOwnedwere type aliases forJValueGen, which was an internal type, but this design led to confusing error messages that made them harder to use)JNI Environment APIs
JNIEnvis no longer a#[transparent]FFI-safe pointer wrapper and has been split intoEnvUnowned(for FFI/native method args) andEnv(non-FFI) (#634)A
JNIEnvtype alias shows a verbose deprecation warning that explains how to migrate fromJNIEnvtoEnvUnownedandEnv(#634)Env::get_versionhas been renamed toEnv::version(#478)Envis no longer ever exposed in the API by-value can only be accessed by borrowing from a thread attachmentAttachGuard.Envimplements runtime borrow checking to ensure new local references may only be associated with the top JNI stack frameJavaVM::get_envis replaced byJavaVM::get_env_attachmentwhich returns anAttachGuardif the current thread is attached. (#570)The following functions are now infallible (#478):
Env::versionEnv::get_java_vmEnv::exception_checkEnv::exception_clearEnv::exception_describeEnv::exception_occurred(#517)Env::is_same_objectEnv::delete_local_refWeakRef::is_same_objectWeakRef::is_weak_ref_to_same_objectWeakRef::is_garbage_collectedEnv::fatal_erroris now guaranteed not to panic or allocate, but requires the error message to be encoded ahead of time. (#480)Env::get_native_interfacehas been removed since it's redundant andEnv::get_rawis more consistent with other APIs.Env::register_native_methodsis now markedunsafesince it requires all the given function pointers to be valid and match corresponding Java method signatures (568)get_object_classborrows theEnvmutably because it creates a new local reference. (#456)get/set_*_field_uncheckedhave been marked as unsafe since they can lead to undefined behaviour if the given types don't match the field type (#457 + #629)set_static_fieldtakes a field name and signature as strings so the ID is looked up internally to ensure it's valid. (#629)Env::get/set/take_rust_fieldno longer require a mutableEnvreference since they don't return any new local references to the caller (#455)Env::get_rust_fieldreturns aMutexGuard<'local>instead of taking the&'env selflifetime (so you don't lose any&mut Envreference you have) (#675)Env::is_assignable_fromandis_instance_ofno longer requires a mutableEnvreference, since they don't return any new local references to the callerEnv::new_weak_refreturns aResult<Weak>andError::ObjectFreedif the reference is null or has already been freed (instead ofResult<Option<Weak>>) (#596)Env::new_global_refand::new_local_refmay returnError::ObjectFreedin case a weak reference was given and the object has been freed. (#596)Env::with_local_framecan be used with a shared&Envreference since it doesn't return a new local reference. (#673)Env::with_local_frame_returning_localcan now return any kind of localReference, not justJObjectEnv::new_object_uncheckednow takes aDesc<JMethodID>for consistency/flexibility instead of directly taking aJMethodIDString APIs
JavaStrhas been renamedMUTF8Chars(with a deprecatedJavaStralias) and is intended to be got viaJString::mutf8_chars()JavaStr/MUTF8Chars::from_envhas been removed because it was unsound (it could cause undefined behavior and was not markedunsafe). UseJString::mutf8_charsinstead. (#510 / #512)JavaStr/MUTF8Chars::get_rawhas been renamed toas_ptr. (#510 / #512)JavaStr/MUTF8Chars,JNIStr, andJNIStringno longer coerce toCStr, because usingCStr::to_strwill often have incorrect results. You can still get aCStr, but must use the newas_cstrmethod to do so. (#510 / #512)Into<JNIString>, now takeAsRef<JNIStr>to avoid string copies every call. Considering that these strings are often literals for signatures or class names, most code can usejni_str!()to encode string literals at compile time, likeenv.find_class(jni_str!("java/lang/Foo")). (#617, #696)JavaStr/MUTF8CharsandJStringboth implementDisplayand thereforeToString, making it even easier to get a RustString.Env::get_stringperformance was optimized by caching an expensive class lookup, and using a faster instanceof check. (#531)Env::get_stringperformance was later further optimized to avoid the need for runtime type checking (#612)Env::get_stringhas been deprecated in favor ofJString::mutf8_charsandJString::to_string()orJString::try_to_string(env)Class Loading APIs
Env::find_classnow recommends consideringLoaderContext::load_classinstead.Desc<JClass>::lookup()is now based onLoaderContext::load_class(instead ofEnv::find_class), which checks for a thread context class loader by default.Env::define_classtakes aname: Option<>instead of having a separatedefine_unnamed_classAPI.Env::define_class_bytearraywas renamed toEnv::define_class_jbyteand is identical todefine_classexcept for taking a&[jbyte]slice instead of&[u8], which is a convenience if you have aJByteArrayorAutoElements<JByteArray>.Env::define_class[_jbyte]now takes aloader: AsRef<JClassLoader>instead ofloader: &JObject.java.lang APIs
JListis a simpler, transparent reference wrapper implementingReference, likeJObject,JClass,JStringetcJList::addreturns the boolean returned by the Java APIJList::getandJList::removeno longer returns anOptionsince there's nothing special about getting anullfrom the JavaListAPI.JList::popis deprecated since this doesn't map to standard JavaListmethod.JList::iterreturns aJIteratorinstead of aJListIterEnv::get_listhas been deprecated, in favor ofJList::cast_local, or other genericEnvcast_local/cast_globalAPIs.Env::get_array_elementsis deprecated in favor ofJPrimitiveArray::get_elementsEnv::get_array_elements_criticalis deprecated in favor ofJPrimitiveArray::get_elements_criticalEnv::get_*_array_regionandEnv::set_*_array_regionare deprecated in favor ofJPrimitiveArray::get/set_regionEnv::get_array_lengthis deprecated in favor ofJPrimitiveArray::lenandJObjectArray::lenEnv::get/set_object_array_elementare deprecated in favor ofJObjectArray::get/set_elementEnv::new_*_arraymethods for primitive array types (likeJByteArray) take a&mut Envand ausizelen, and the docs recommend usingJ<Type>Array::new()instead.Miscellaneous
AutoElements[Critical]::discard()now takes ownership of the elements and drops them to release the pointer after setting the mode toNoCopyBack(#645)MonitorGuardwith#[must_use]to warn when the guard is dropped accidentally (#676)NativeMethod(used withEnv::register_native_methods) is a now a transparentjni::sys::JNINativeWrapperwrapper with anunsafe::from_raw_partsconstructor.Env::get_method_id,Env::call_methodetc) now require a pre-parsedMethodSignatureorFieldSignaturetype instead of a raw string. This enables compile-time signature parsing via thejni_sig!macro, and avoids runtime signature parsing costs. (#714)Dependencies
jni-sysdependency bumped to0.4(#478)Fixed
Env::get_stringno longer leaks local references. (#528, #557)Removed
JavaVM::attach_current_thread_as_daemon(and general support for 'daemon' threads) has been removed, since their semantics are inherently poorly defined and unsafe (the distinction relates to the poorly defined limbo state after callingJavaDestroyVM, where it becomes undefined to touch the JVM) (#593)AttachGuard::with_envcan be used instead) (#570)Env::from_raw,Env::from_raw_uncheckedandEnv::unsafe_clonehave been removed, since the API no longer exposes theEnvtype by-value, it must always be borrowed from anAttachGuard. (#570)Error::NullDerefandError::JavaVMMethodNotFoundhave been removed since they were unused.JavaType::Methodwas removed since a method signature isn't a type, and all usage was being matched as unreachable or an error.Env::define_unnamed_classwas removed in favor of having thedefine_class[_jbyte]APIs take aname: Optioninstead.Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Renovate Bot.
View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.Merge
Merge the changes and update on Forgejo.Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.