Struct idb_sys::KeyCursor

pub struct KeyCursor { /* private fields */ }

Represents a key cursor for traversing or iterating over multiple records (only keys) in a database.

Implementations

impl KeyCursor

pub fn source(&self) -> Object

Returns the ObjectStore or Index the cursor was opened from.

pub fn direction(&self) -> Result<CursorDirection, Error>

Returns the direction of the cursor.

pub fn key(&self) -> Result<JsValue, Error>

Returns the key of the cursor. Returns an Error if the cursor is advancing or is finished.

pub fn primary_key(&self) -> Result<JsValue, Error>

Returns the effective key of the cursor. Returns an Error if the cursor is advancing or is finished.

pub fn request(&self) -> StoreRequest

Returns the StoreRequest that was used to obtain this cursor.

pub fn advance(&self, count: u32) -> Result<(), Error>

Advances the cursor through the next count records in range.

pub fn next(&self, key: Option<&JsValue>) -> Result<(), Error>

Advances the cursor to the next record in range matching or after key (if provided).

pub fn next_primary_key(
    &self,
    key: &JsValue,
    primary_key: &JsValue
) -> Result<(), Error>

Advances the cursor to the next record in range matching or after key and primary key. Returns an Error if the source is not an Index.

pub fn update(&self, value: &JsValue) -> Result<StoreRequest, Error>

Updated the record pointed at by the cursor with a new value.

pub fn delete(&self) -> Result<StoreRequest, Error>

Delete the record pointed at by the cursor with a new value.

Trait Implementations

impl Clone for KeyCursor

fn clone(&self) -> KeyCursor

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyCursor

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

Formats the value using the given formatter.

impl From<IdbCursor> for KeyCursor

fn from(inner: IdbCursor) -> Self

Converts to this type from the input type.

impl From<KeyCursor> for IdbCursor

fn from(cursor: KeyCursor) -> Self

Converts to this type from the input type.

impl From<KeyCursor> for JsValue

fn from(cursor: KeyCursor) -> Self

Converts to this type from the input type.

impl PartialEq<KeyCursor> for KeyCursor

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl TryFrom<JsValue> for KeyCursor

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for KeyCursor

impl StructuralEq for KeyCursor

impl StructuralPartialEq for KeyCursor