Struct String

pub struct String<'env> { /* private fields */ }

A type representing a Java String.

Implementations

impl<'env> String<'env>

pub fn empty<'a>( env: &'a JniEnv<'a>, token: &NoException<'a>, ) -> JavaResult<'a, String<'a>>

Create a new empty string.

JNI documentation

pub fn new<'a>( env: &'a JniEnv<'a>, string: &str, token: &NoException<'a>, ) -> JavaResult<'a, String<'a>>

Create a new Java string from a Rust string.

JNI documentation

pub fn len(&self, _token: &NoException<'_>) -> usize

String length (the number of unicode characters).

JNI documentation

pub fn size(&self, _token: &NoException<'_>) -> usize

String size (the number of bytes in modified UTF-8).

JNI documentation

pub fn as_string(&self, token: &NoException<'_>) -> String

Convert the Java String into a Rust String.

This method has a different signature from the one in the ToString trait because extracting bytes from String is only safe when there is no pending exception.

JNI documentation

impl<'env> String<'env>

pub fn get_class( env: &'env JniEnv<'env>, token: &NoException<'env>, ) -> JavaResult<'env, Class<'env>>

Get the Java class object for String .

Object::getClass javadoc

impl<'env> String<'env>

pub fn clone(&self, token: &NoException<'env>) -> JavaResult<'env, Self>

where Self: Sized,

Clone the String . This is not a deep clone of the Java object, but a Rust-like clone of the value. Since Java objects are reference counted, this will increment the reference count.

This method has a different signature from the one in the Clone trait because cloning a Java object is only safe when there is no pending exception and because cloning a java object cat throw an exception.

JNI documentation

pub fn to_string( &self, token: &NoException<'env>, ) -> JavaResult<'env, String<'env>>

Convert the object to a string.

Object::toString javadoc

pub fn value_of_int( env: &'env JniEnv<'env>, value: i32, token: &NoException<'env>, ) -> JavaResult<'env, String<'env>>

Get the string value of an integer.

String::valueOf(int) javadoc

Methods from Deref<Target = Object<'env>>

pub unsafe fn raw_object(&self) -> jobject

Get the raw object pointer.

This function provides low-level access to the Java object and thus is unsafe.

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

Get the JniEnv this object is bound to.

pub fn class(&self, _token: &NoException<'_>) -> Class<'env>

Get the object’s class.

JNI documentation

pub fn is_same_as(&self, other: &Object<'_>, _token: &NoException<'_>) -> bool

Compare with another Java object by reference.

JNI documentation

pub fn is_instance_of( &self, class: &Class<'_>, _token: &NoException<'_>, ) -> bool

Check if the object is an instance of the class.

JNI documentation

pub fn clone(&self, token: &NoException<'env>) -> JavaResult<'env, Object<'env>>

Clone the Object. This is not a deep clone of the Java object, but a Rust-like clone of the value. Since Java objects are reference counted, this will increment the reference count.

This method has a different signature from the one in the Clone trait because cloning a Java object is only safe when there is no pending exception and because cloning a java object cat throw an exception.

JNI documentation

pub fn to_string( &self, token: &NoException<'env>, ) -> JavaResult<'env, String<'env>>

Convert the object to a string.

Object::toString javadoc

pub fn equals( &self, other: &Object<'_>, token: &NoException<'env>, ) -> JavaResult<'env, bool>

Compare to another Java object.

Object::equals

Trait Implementations

impl<'env> Cast<'env, Object<'env>> for String<'env>

Make String castable to Object.

fn cast<'a>(&'a self) -> &'a Object<'env>

Cast the object to itself or one of it’s superclasses.

impl<'env> Cast<'env, String<'env>> for String<'env>

Make String castable to itself.

fn cast<'a>(&'a self) -> &'a String<'env>

Cast the object to itself or one of it’s superclasses.

impl<'env> Debug for String<'env>

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

Formats the value using the given formatter.

impl<'env> Deref for String<'env>

Allow String to be used in place of an Object.

type Target = Object<'env>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'env> Display for String<'env>

Allow displaying String .

Object::toString javadoc

This is mostly a convenience for debugging. Always prefer using to_string to printing the object as is, because the former checks for a pending exception in compile-time rather than the run-time.

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

Formats the value using the given formatter.

impl<'env, T> PartialEq<T> for String<'env>

where T: Cast<'env, Object<'env>>,

Allow comparing String to Java objects. Java objects are compared by-reference to preserve original Java semantics. To compare objects by value, call the equals method.

Will panic if there is a pending exception in the current thread.

This is mostly a convenience for using assert_eq!() in tests. Always prefer using is_same_as to comparing with ==, because the former checks for a pending exception in compile-time rather than the run-time.

fn eq(&self, other: &T) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'env> Eq for String<'env>

Allow comparing String to Java objects. Java objects are compared by-reference to preserve original Java semantics. To compare objects by value, call the equals method.

Will panic if there is a pending exception in the current thread.

This is mostly a convenience for using assert_eq!() in tests. Always prefer using is_same_as to comparing with ==, because the former checks for a pending exception in compile-time rather than the run-time.

impl<'a> JavaType for String<'a>

Make String mappable to jobject.