Struct Index

pub struct Index<Err> { /* private fields */ }

Wrapper for IDBIndex, for use in transactions

Most of the functions here take a JsValue as the key(s) to use in the index. If the index was built with a compound key, then you should use eg. js_sys::Array::from_iter([key_1, key_2]) as the key.

Implementations

impl<Err> Index<Err>

pub fn contains(&self, key: &JsValue) -> impl Future<Output = Result<bool, Err>>

Checks whether the provided key (for this index) already exists

Internally, this uses IDBIndex::count.

pub fn count_in( &self, range: impl RangeBounds<JsValue>, ) -> impl Future<Output = Result<usize, Err>>

Count all the keys (for this index) in the provided range

Internally, this uses IDBIndex::count.

pub fn get( &self, key: &JsValue, ) -> impl Future<Output = Result<Option<JsValue>, Err>>

Get the object with key key for this index

Internally, this uses IDBIndex::get.

pub fn get_first_in( &self, range: impl RangeBounds<JsValue>, ) -> impl Future<Output = Result<Option<JsValue>, Err>>

Get the first value with a key (for this index) in range, ordered by key (for this index)

Note that the unbounded range is not a valid range for IndexedDB.

Internally, this uses IDBIndex::get.

pub fn get_all( &self, limit: Option<u32>, ) -> impl Future<Output = Result<Vec<JsValue>, Err>>

Get all the objects in the store, ordered by this index, with a maximum number of results of limit

Internally, this uses IDBIndex::getAll.

pub fn get_all_in( &self, range: impl RangeBounds<JsValue>, limit: Option<u32>, ) -> impl Future<Output = Result<Vec<JsValue>, Err>>

Get all the objects with a key (for this index) in the provided range, with a maximum number of results of limit, ordered by this index

Internally, this uses IDBIndex::getAll.

pub fn get_first_key_in( &self, range: impl RangeBounds<JsValue>, ) -> impl Future<Output = Result<Option<JsValue>, Err>>

Get the first existing primary key for an object that has a key (for this index) in the provided range

Internally, this uses IDBIndex::getKey.

pub fn get_all_keys( &self, limit: Option<u32>, ) -> impl Future<Output = Result<Vec<JsValue>, Err>>

List all the primary keys in the object store, with a maximum number of results of limit, ordered by this index

Internally, this uses IDBIndex::getAllKeys.

pub fn get_all_keys_in( &self, range: impl RangeBounds<JsValue>, limit: Option<u32>, ) -> impl Future<Output = Result<Vec<JsValue>, Err>>

List all the primary keys of objects with a key (for this index)in the provided range, with a maximum number of results of limit, ordered by this index

Internally, this uses IDBIndex::getAllKeys.

pub fn cursor(&self) -> CursorBuilder<Err>

Open a Cursor on this index