Struct idb::ObjectStore

pub struct ObjectStore { /* private fields */ }

Represents an object store in a database.

Implementations

impl ObjectStore

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 async fn put(
    &self,
    value: &JsValue,
    key: Option<&JsValue>
) -> Result<JsValue, Error>

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

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

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

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

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

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

Deletes all records in store.

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

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

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

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

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

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

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

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

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

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

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

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

pub async fn open_key_cursor(
    &self,
    query: Option<Query>,
    cursor_direction: Option<CursorDirection>
) -> Result<Option<KeyCursor>, 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.

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<ObjectStore> for JsValue

fn from(value: ObjectStore) -> Self

Converts to this type from the input type.

impl From<ObjectStore> for ObjectStore

fn from(inner: SysObjectStore) -> Self

Converts to this type from the input type.

impl From<ObjectStore> for SysObjectStore

fn from(object_store: ObjectStore) -> Self

Converts to this type from the input type.

impl PartialEq<ObjectStore> for ObjectStore

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

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

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

This method 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 StructuralEq for ObjectStore

impl StructuralPartialEq for ObjectStore