Struct ObjectStore

pub struct ObjectStore { /* private fields */ }

Represents an object store in a database.

Implementations

impl ObjectStore

pub fn builder(name: &str) -> ObjectStoreBuilder

Available on crate feature builder only.

Creates a new instance of ObjectStoreBuilder.

pub fn name(&self) -> String

Returns the name of the store.

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

Updates the name of the store to newName. Returns and Error if not called within an upgrade transaction.

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

Returns the key path of the store.

pub fn index_names(&self) -> Vec<String>

Returns a list of the names of indexes in the store.

pub fn transaction(&self) -> Transaction

Returns the associated Transaction.

pub fn auto_increment(&self) -> bool

Returns true if the store has a key generator, and false otherwise.

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

Adds or updates a record in store with the given value and key.

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

Adds a record in store with the given value and key.

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

Deletes records in store with the given key or in the given key range in query.

pub fn clear(&self) -> Result<ClearStoreRequest, Error>

Deletes all records in store.

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 store 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 store are matched.

pub fn index(&self, name: &str) -> Result<Index, Error>

Returns an Index for the index named name in store.

pub fn create_index( &self, name: &str, key_path: KeyPath, params: Option<IndexParams>, ) -> Result<Index, Error>

Creates a new index in store with the given name, key path and options and returns a new Index. Returns an Error if not called within an upgrade transaction or an index with the name already exists.

pub fn delete_index(&self, name: &str) -> Result<(), Error>

Deletes the index in store with the given name. Returns an Error if not called within an upgrade transaction.

Trait Implementations

impl Clone for ObjectStore

fn clone(&self) -> ObjectStore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectStore

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

Formats the value using the given formatter.

impl From<IdbObjectStore> for ObjectStore

fn from(inner: IdbObjectStore) -> Self

Converts to this type from the input type.

impl From<ObjectStore> for IdbObjectStore

fn from(object_store: ObjectStore) -> Self

Converts to this type from the input type.

impl From<ObjectStore> for JsValue

fn from(value: ObjectStore) -> Self

Converts to this type from the input type.

impl PartialEq for ObjectStore

fn eq(&self, other: &ObjectStore) -> 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 ObjectStore

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 ObjectStore

impl StructuralPartialEq for ObjectStore