Struct Cursor 

pub struct Cursor { /* private fields */ }

Streaming cursor over object store or secondary index rows.

Implementations

impl Cursor

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

Returns the current cursor key.

pub fn primary_key(&self) -> &str

Returns the current row’s primary key.

pub fn value(&self) -> Result<Record, IndexedDBError>

Returns the current row value.

pub async fn continue_next(&mut self) -> Result<bool, IndexedDBError>

Advances the cursor by one row.

pub async fn continue_to_key( &mut self, key: Value, ) -> Result<bool, IndexedDBError>

Advances the cursor to key, or exhausts it if key does not exist.

pub async fn advance(&mut self, count: i32) -> Result<bool, IndexedDBError>

Skips count rows ahead.

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

Deletes the current row and keeps the cursor open.

pub async fn update(&mut self, value: Record) -> Result<(), IndexedDBError>

Replaces the current row and keeps the cursor open.

pub async fn close(self) -> Result<(), IndexedDBError>

Closes the cursor stream and releases its transport resources.

Trait Implementations

impl CursorApi for Cursor

fn key(&self) -> Option<Value>

Returns the current cursor key.

fn primary_key(&self) -> &str

Returns the current row’s primary key.

fn value(&self) -> Result<Record, IndexedDBError>

Returns the current row value.

fn continue_next<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<bool, IndexedDBError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Advances the cursor by one row.

fn continue_to_key<'life0, 'async_trait>( &'life0 mut self, key: Value, ) -> Pin<Box<dyn Future<Output = Result<bool, IndexedDBError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Advances the cursor to key, or exhausts it if key does not exist.

fn advance<'life0, 'async_trait>( &'life0 mut self, count: i32, ) -> Pin<Box<dyn Future<Output = Result<bool, IndexedDBError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Skips count rows ahead.

fn delete<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), IndexedDBError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes the current row and keeps the cursor open.

fn update<'life0, 'async_trait>( &'life0 mut self, value: Record, ) -> Pin<Box<dyn Future<Output = Result<(), IndexedDBError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Replaces the current row and keeps the cursor open.

fn close<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<(), IndexedDBError>> + Send + 'async_trait>>

where Self: 'async_trait,

Closes the cursor stream and releases its transport resources.