Struct Index

pub struct Index { /* private fields */ }

Provides asynchronous access to an index in a database.

Implementations

impl Index

pub fn builder(name: String, key_path: KeyPath) -> IndexBuilder

Available on crate feature builder only.

Creates a new instance of IndexBuilder.

pub fn name(&self) -> String

Returns the name of the index.

pub fn set_name(&self, name: &str)

Updates the name of the index.

pub fn object_store(&self) -> ObjectStore

Returns the ObjectStore the index belongs to.

pub fn key_path(&self) -> Result<Option<KeyPath>, Error>

Returns the key path of the index.

pub fn multi_entry(&self) -> bool

Returns true if the index’s multi_entry flag is true.

pub fn unique(&self) -> bool

Returns true if the index’s unique flag is true.

pub fn get(&self, query: impl Into<Query>) -> Result<GetStoreRequest, Error>

Retrieves the value of the first record matching the given key or key range in query.

pub fn get_key( &self, query: impl Into<Query>, ) -> Result<GetKeyStoreRequest, Error>

Retrieves the key of the first record matching the given key or key range in query.

pub fn get_all( &self, query: Option<Query>, limit: Option<u32>, ) -> Result<GetAllStoreRequest, Error>

Retrieves the values of the records matching the given key or key range in query (up to limit if given).

pub fn get_all_keys( &self, query: Option<Query>, limit: Option<u32>, ) -> Result<GetAllKeysStoreRequest, Error>

Retrieves the keys of records matching the given key or key range in query (up to limit if given).

pub fn count(&self, query: Option<Query>) -> Result<CountStoreRequest, Error>

Retrieves the number of records matching the given key or key range in query.

pub fn open_cursor( &self, query: Option<Query>, cursor_direction: Option<CursorDirection>, ) -> Result<OpenCursorStoreRequest, Error>

Opens a Cursor over the records matching query, ordered by direction. If query is None, all records in index are matched.

pub fn open_key_cursor( &self, query: Option<Query>, cursor_direction: Option<CursorDirection>, ) -> Result<OpenKeyCursorStoreRequest, Error>

Opens a KeyCursor over the records matching query, ordered by direction. If query is None, all records in index are matched.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl From<IdbIndex> for Index

fn from(inner: IdbIndex) -> Self

Converts to this type from the input type.

impl From<Index> for IdbIndex

fn from(index: Index) -> Self

Converts to this type from the input type.

impl From<Index> for JsValue

fn from(value: Index) -> Self

Converts to this type from the input type.

impl PartialEq for Index

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<JsValue> for Index

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 Index

impl StructuralPartialEq for Index