Struct Transaction

pub struct Transaction { /* private fields */ }

Provides a static, asynchronous transaction on a database. All reading and writing of data is done within transactions.

Implementations

impl Transaction

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

Returns a list of the names of object stores in the transaction’s scope. For an upgrade transaction this is all object stores in the database.

pub fn mode(&self) -> Result<TransactionMode, Error>

Returns the mode the transaction was created with (“readonly” or “readwrite”), or “versionchange” for an upgrade transaction.

pub fn database(&self) -> Database

Returns the transaction’s connection.

pub fn error(&self) -> Option<DomException>

If the transaction was aborted, returns the error (a DOMException) providing the reason.

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

Returns an ObjectStore in the transaction’s scope.

pub fn commit(self) -> Result<Self, Error>

Attempts to commit the transaction. All pending requests will be allowed to complete, but no new requests will be accepted. This can be used to force a transaction to quickly finish, without waiting for pending requests to fire success events before attempting to commit normally.

pub fn abort(self) -> Result<Self, Error>

Aborts the transaction. All pending requests will fail and all changes made to the database will be reverted.

pub fn on_abort<F>(&mut self, callback: F)

where F: FnOnce(Event) + 'static,

Adds an event handler for abort event.

pub fn on_complete<F>(&mut self, callback: F)

where F: FnOnce(Event) + 'static,

Adds an event handler for complete event.

pub fn on_error<F>(&mut self, callback: F)

where F: FnOnce(Event) + 'static,

Adds an event handler for error event.

pub fn forget_callbacks(&mut self)

Release memory management of the callbacks to JS GC.

Note: This may leak memory. Read more about it here.

Trait Implementations

impl Debug for Transaction

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

Formats the value using the given formatter.

impl From<IdbTransaction> for Transaction

fn from(inner: IdbTransaction) -> Self

Converts to this type from the input type.

impl From<Transaction> for IdbTransaction

fn from(transaction: Transaction) -> Self

Converts to this type from the input type.

impl From<Transaction> for JsValue

fn from(value: Transaction) -> Self

Converts to this type from the input type.

impl IntoFuture for Transaction

type Output = <<Transaction as IntoFuture>::IntoFuture as Future>::Output

The output that the future will produce on completion.

type IntoFuture = TransactionFuture

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl TryFrom<EventTarget> for Transaction

type Error = Error

The type returned in the event of a conversion error.

fn try_from(target: EventTarget) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<JsValue> for Transaction

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.