Struct Cursor

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

Wrapper for IDBCursorWithValue

Implementations

impl<Err> Cursor<Err>

pub fn value(&self) -> Option<JsValue>

Retrieve the value this Cursor is currently pointing at, or None if the cursor is completed

If this cursor was opened as a key-only cursor, then trying to call this method will panic.

Internally, this uses the IDBCursorWithValue::value property.

pub fn key(&self) -> Option<JsValue>

Retrieve the key this Cursor is currently pointing at, or None if the cursor is completed

Internally, this uses the IDBCursor::key property.

pub fn primary_key(&self) -> Option<JsValue>

Retrieve the primary key this Cursor is currently pointing at, or None if the cursor is completed

Internally, this uses the IDBCursor::primaryKey property.

pub async fn advance(&mut self, count: u32) -> Result<(), Err>

Advance this Cursor by count elements

Internally, this uses IDBCursor::advance.

pub async fn advance_until(&mut self, key: &JsValue) -> Result<(), Err>

Advance this Cursor until the provided key

Internally, this uses IDBCursor::continue.

pub async fn advance_until_primary_key( &mut self, index_key: &JsValue, primary_key: &JsValue, ) -> Result<(), Err>

Advance this Cursor until the provided primary key

This is a helper function for cursors built on top of Indexes. It allows for quick resumption of index walking, faster than Cursor::advance_until if the primary key for the wanted element is known.

Note that this method does not work on cursors over object stores, nor on cursors which are set with a direction of anything other than Next or Prev.

Internally, this uses IDBCursor::continuePrimaryKey.

pub async fn delete(&self) -> Result<(), Err>

Deletes the value currently pointed by this Cursor

Note that this method does not work on key-only cursors over indexes.

Internally, this uses IDBCursor::delete.

pub async fn update(&self, value: &JsValue) -> Result<(), Err>

Update the value currently pointed by this Cursor to value

Note that this method does not work on key-only cursors over indexes.

Internally, this uses IDBCursor::update.