Struct Index 

pub struct Index { /* private fields */ }

Lookup and cursor access through one secondary index.

Implementations

impl Index

pub async fn get( &mut self, query: impl Into<Query>, ) -> Result<Record, IndexedDBError>

Loads the first row that matches query.

pub async fn get_key( &mut self, query: impl Into<Query>, ) -> Result<String, IndexedDBError>

Resolves the primary key for the first row that matches query.

pub async fn get_all( &mut self, query: impl Into<Query>, count: Option<u32>, ) -> Result<Vec<Record>, IndexedDBError>

Loads every row that matches query.

pub async fn get_all_keys( &mut self, query: impl Into<Query>, count: Option<u32>, ) -> Result<Vec<String>, IndexedDBError>

Loads every primary key that matches query.

pub async fn count( &mut self, query: impl Into<Query>, ) -> Result<i64, IndexedDBError>

Counts rows that match query.

pub async fn delete( &mut self, query: impl Into<Query>, ) -> Result<i64, IndexedDBError>

Deletes rows that match query and returns the delete count.

pub async fn open_cursor( &mut self, query: impl Into<Query>, direction: CursorDirection, ) -> Result<Cursor, IndexedDBError>

Opens a full-value cursor over the secondary index.

pub async fn open_key_cursor( &mut self, query: impl Into<Query>, direction: CursorDirection, ) -> Result<Cursor, IndexedDBError>

Opens a key-only cursor over the secondary index.

Trait Implementations

impl IndexApi for Index

type Cursor = Cursor

The cursor handle this scope yields.

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

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

Loads the first row that matches query.

fn get_key<'life0, 'async_trait>( &'life0 mut self, query: Query, ) -> Pin<Box<dyn Future<Output = Result<String, IndexedDBError>> + Send + 'async_trait>>

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

Resolves the primary key for the first row that matches query.

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

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

Loads every row that matches query.

fn get_all_keys<'life0, 'async_trait>( &'life0 mut self, query: Query, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, IndexedDBError>> + Send + 'async_trait>>

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

Loads every primary key that matches query.

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

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

Counts rows that match query.

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

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

Deletes rows that match query and returns the delete count.

fn open_cursor<'life0, 'async_trait>( &'life0 mut self, query: Query, direction: CursorDirection, ) -> Pin<Box<dyn Future<Output = Result<Cursor, IndexedDBError>> + Send + 'async_trait>>

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

Opens a full-value cursor over the secondary index.

fn open_key_cursor<'life0, 'async_trait>( &'life0 mut self, query: Query, direction: CursorDirection, ) -> Pin<Box<dyn Future<Output = Result<Cursor, IndexedDBError>> + Send + 'async_trait>>

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

Opens a key-only cursor over the secondary index.