Struct JMap

pub struct JMap<'a, 'b>
where
    'a: 'b,
{ /* private fields */ }

Wrapper for JObjects that implement java/util/Map. Provides methods to get and set entries and a way to iterate over key/value pairs.

Looks up the class and method ids on creation rather than for every method call.

Implementations

impl<'a, 'b> JMap<'a, 'b>

where 'a: 'b,

pub fn from_env( env: &'b JNIEnv<'a>, obj: JObject<'a>, ) -> Result<JMap<'a, 'b>, Error>

Create a map from the environment and an object. This looks up the necessary class and method ids to call all of the methods on it so that exra work doesn’t need to be done on every method call.

pub fn get(&self, key: JObject<'a>) -> Result<Option<JObject<'a>>, Error>

Look up the value for a key. Returns Some if it’s found and None if a null pointer would be returned.

pub fn put( &self, key: JObject<'a>, value: JObject<'a>, ) -> Result<Option<JObject<'a>>, Error>

Look up the value for a key. Returns Some with the old value if the key already existed and None if it’s a new key.

pub fn remove(&self, key: JObject<'a>) -> Result<Option<JObject<'a>>, Error>

Remove a value from the map. Returns Some with the removed value and None if there was no value for the key.

pub fn iter(&self) -> Result<JMapIter<'a, 'b, '_>, Error>

Get key/value iterator for the map. This is done by getting the EntrySet from java and iterating over it.

Trait Implementations

impl<'a, 'b> From<JMap<'a, 'b>> for JObject<'a>

where 'a: 'b,

fn from(other: JMap<'a, 'b>) -> JObject<'a>

Converts to this type from the input type.

impl<'a, 'b> Deref for JMap<'a, 'b>

where 'a: 'b,

type Target = JObject<'a>

The resulting type after dereferencing.

fn deref(&self) -> &<JMap<'a, 'b> as Deref>::Target

Dereferences the value.