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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

use js_sys::Object;
use wasm_bindgen::JsValue;

use crate::{CursorDirection, Error, KeyCursor};

/// A key cursor that is managed by the library (for ease of use).
#[cfg(feature = "futures")]
#[cfg_attr(any(docsrs, feature = "doc"), doc(cfg(feature = "futures")))]
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ManagedKeyCursor {
    inner: Option<KeyCursor>,
}

impl ManagedKeyCursor {
    /// Returns the [`ObjectStore`](crate::ObjectStore) or [`Index`](crate::Index) the cursor was opened from.
    // TODO: make return type as enum: (IDBObjectStore or IDBIndex)
    pub fn source(&self) -> Option<Object> {
        self.inner.as_ref().map(|cursor| cursor.source())
    }

    /// Returns the direction of the cursor.
    pub fn direction(&self) -> Result<Option<CursorDirection>, Error> {
        self.inner
            .as_ref()
            .map(|cursor| cursor.direction())
            .transpose()
    }

    /// Returns the key of the cursor. Returns an [`Error`] if the cursor is advancing or is finished.
    pub fn key(&self) -> Result<Option<JsValue>, Error> {
        self.inner.as_ref().map(|cursor| cursor.key()).transpose()
    }

    /// Returns the effective key of the cursor. Returns an [`Error`] if the cursor is advancing or is finished.
    pub fn primary_key(&self) -> Result<Option<JsValue>, Error> {
        self.inner
            .as_ref()
            .map(|cursor| cursor.primary_key())
            .transpose()
    }

    /// Advances the cursor through the next count records in range.
    pub async fn advance(&mut self, count: u32) -> Result<(), Error> {
        let new_inner = {
            let inner = self.inner.as_ref().ok_or(Error::CursorFinished)?;
            inner.advance(count)?.await?
        };

        self.inner = new_inner;

        Ok(())
    }

    /// Advances the cursor to the next record in range matching or after key (if provided).
    pub async fn next(&mut self, key: Option<&JsValue>) -> Result<(), Error> {
        let new_inner = {
            let inner = self.inner.as_ref().ok_or(Error::CursorFinished)?;
            inner.next(key)?.await?
        };

        self.inner = new_inner;

        Ok(())
    }

    /// Advances the cursor to the next record in range matching or after key and primary key. Returns an [`Error`] if
    /// the source is not an [`Index`](crate::Index).
    pub async fn next_primary_key(
        &mut self,
        key: &JsValue,
        primary_key: &JsValue,
    ) -> Result<(), Error> {
        let new_inner = {
            let inner = self.inner.as_ref().ok_or(Error::CursorFinished)?;
            inner.next_primary_key(key, primary_key)?.await?
        };

        self.inner = new_inner;

        Ok(())
    }

    /// Updated the record pointed at by the cursor with a new value.
    pub async fn update(&self, value: &JsValue) -> Result<JsValue, Error> {
        self.inner
            .as_ref()
            .ok_or(Error::CursorFinished)?
            .update(value)?
            .await
    }

    /// Delete the record pointed at by the cursor with a new value.
    pub async fn delete(&self) -> Result<(), Error> {
        self.inner
            .as_ref()
            .ok_or(Error::CursorFinished)?
            .delete()?
            .await
    }
}

impl From<KeyCursor> for ManagedKeyCursor {
    fn from(inner: KeyCursor) -> Self {
        Self { inner: Some(inner) }
    }
}