idb 0.6.5

A futures based crate for interacting with IndexedDB on browsers using webassembly
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

use crate::{Error, IndexParams, KeyPath, ObjectStore};

/// Builder for object store indexes.
#[derive(Debug)]
pub struct IndexBuilder {
    name: String,
    key_path: KeyPath,
    unique: Option<bool>,
    multi_entry: Option<bool>,
}

impl IndexBuilder {
    /// Creates a new instance of [`IndexBuilder`].
    pub fn new(name: String, key_path: KeyPath) -> Self {
        Self {
            name,
            key_path,
            unique: None,
            multi_entry: None,
        }
    }

    /// Returns the name of the index.
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Sets the `unique` flag.
    pub fn unique(mut self, unique: bool) -> Self {
        self.unique = Some(unique);
        self
    }

    /// Sets the `multi_entry` flag.
    pub fn multi_entry(mut self, multi_entry: bool) -> Self {
        self.multi_entry = Some(multi_entry);
        self
    }

    /// Applies the index to the given object store.
    pub(crate) fn apply(self, object_store: &ObjectStore) -> Result<(), Error> {
        if let Ok(existing_index) = object_store.index(&self.name) {
            let indexes_equal = existing_index.key_path()?.as_ref() == Some(&self.key_path)
                && Some(existing_index.unique()) == self.unique
                && Some(existing_index.multi_entry()) == self.multi_entry;
            if indexes_equal {
                // skip re-creating the same index
                return Ok(());
            } else {
                object_store.delete_index(&self.name)?;
            }
        }
        let mut params = IndexParams::new();

        if let Some(unique) = self.unique {
            params.unique(unique);
        }

        if let Some(multi_entry) = self.multi_entry {
            params.multi_entry(multi_entry);
        }

        object_store.create_index(&self.name, self.key_path, Some(params))?;

        Ok(())
    }
}