Struct idb_sys::ObjectStore

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

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

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

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

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

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

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

Deletes all records in store.

pub fn get(&self, query: impl Into<Query>) -> Result<StoreRequest, 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<StoreRequest, 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<StoreRequest, 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<StoreRequest, 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<StoreRequest, 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<StoreRequest, 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<StoreRequest, 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. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for ObjectStore

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

Formats the value using the given formatter. Read more

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

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

1.0.0 · source§

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

Auto Trait Implementations§

impl UnwindSafe for ObjectStore

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.