rexie

Rexie is an easy-to-use, futures based wrapper around IndexedDB that compiles to webassembly.

Usage

To use Rexie, you need to add the following to your Cargo.toml:

toml [dependencies] rexie = "0.1"

Example

To create a new database, you can use the Rexie::builder method:

```rust use rexie::*;

async fn builddatabase() -> Result { // Create a new database let rexie = Rexie::builder("test") // Set the version of the database to 1.0 .version(1) // Add an object store named employees .addobjectstore( ObjectStore::new("employees") // Set the key path to id .keypath("id") // Enable auto increment .autoincrement(true) // Add an index named email with the key path email with unique enabled .addindex(Index::new("email", "email").unique(true)), ) // Build the database .build() .await?;

// Check basic details of the database
assert_eq!(rexie.name(), "test");
assert_eq!(rexie.version(), 1.0);
assert_eq!(rexie.store_names(), vec!["employees"]);

Ok(rexie)

} ```

To add an employee, you can use the Store::add method after creating a Transaction:

```rust use rexie::*;

async fn add_employee(rexie: &Rexie, name: &str, email: &str) -> Result { // Create a new read-write transaction let transaction = rexie.transaction(&["employees"], TransactionMode::ReadWrite)?;

// Get the `employees` store
let employees = transaction.store("employees")?;

// Create an employee
let employee = serde_json::json!({
    "name": name,
    "email": email,
});
// Convert it to `JsValue`
let employee = serde_wasm_bindgen::to_value(&employee).unwrap();

// Add the employee to the store
let employee_id = employees.add(&employee, None).await?;

// Commit the transaction
transaction.commit().await?;

// Return the employee id
Ok(num_traits::cast(employee_id.as_f64().unwrap()).unwrap())

} ```

To get an employee, you can use the Store::get method after creating a Transaction:

```rust use rexie::*;

async fn get_employee(rexie: &Rexie, id: u32) -> Result> { // Create a new read-only transaction let transaction = rexie.transaction(&["employees"], TransactionMode::ReadOnly)?;

// Get the `employees` store
let employees = transaction.store("employees")?;

// Get the employee
let employee = employees.get(&id.into()).await?;
// Convert it to `serde_json::Value` from `JsValue`
let employee: Option<serde_json::Value> = serde_wasm_bindgen::from_value(employee).unwrap();

// Commit the transaction
transaction.commit().await?;

// Return the employee
Ok(employee)

} ```

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.