obj-db 1.1.1

Embedded document database. Stable file format, full ACID, single-file portability.
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

//! `AsyncCollection` — async-facing wrapper over a runtime-named
//! read-only [`crate::Collection`] handle.
//!
//! Construction is infallible (see [`crate::Db::collection`]); each
//! async method opens a fresh blocking [`crate::Db::collection`]
//! handle inside the [`blocking`] pool and dispatches one of its
//! read-only methods.
//!
//! Writes via a runtime-named handle are intentionally out of scope —
//! Phase 1B (M11 #94) limits the runtime accessor to reads. Use
//! [`crate::asynchronous::AsyncDb::transaction`] +
//! [`crate::WriteTxn::collection`] for the typed-write path.

use std::marker::PhantomData;
use std::sync::Arc;

use obj_core::{Document, Id, Result};

use crate::asynchronous::db::unblock;
use crate::Db;

/// Async-facing wrapper over a runtime-named read-only collection
/// handle.
///
/// Cheap to clone — holds one `Arc<Db>` + the collection name.
#[derive(Debug)]
pub struct AsyncCollection<T> {
    db: Arc<Db>,
    name: String,
    _phantom: PhantomData<fn() -> T>,
}

impl<T> Clone for AsyncCollection<T> {
    fn clone(&self) -> Self {
        Self {
            db: Arc::clone(&self.db),
            name: self.name.clone(),
            _phantom: PhantomData,
        }
    }
}

impl<T> AsyncCollection<T>
where
    T: Document + Send + 'static,
{
    pub(crate) fn lazy(db: Arc<Db>, name: String) -> Self {
        Self {
            db,
            name,
            _phantom: PhantomData,
        }
    }

    /// Async sibling of [`crate::Collection::get`]. Opens a private
    /// read transaction inside the blocking task.
    ///
    /// # Errors
    ///
    /// As [`crate::Collection::get`].
    pub async fn get(&self, id: Id) -> Result<Option<T>> {
        let db = Arc::clone(&self.db);
        let name = self.name.clone();
        unblock(move || db.collection::<T>(name).get(id)).await
    }

    /// Async sibling of [`crate::Collection::all`].
    ///
    /// # Errors
    ///
    /// As [`crate::Collection::all`].
    pub async fn all(&self) -> Result<Vec<(Id, T)>> {
        let db = Arc::clone(&self.db);
        let name = self.name.clone();
        unblock(move || db.collection::<T>(name).all()).await
    }

    /// Async sibling of [`crate::Collection::count_all`].
    ///
    /// # Errors
    ///
    /// As [`crate::Collection::count_all`].
    pub async fn count_all(&self) -> Result<u64> {
        let db = Arc::clone(&self.db);
        let name = self.name.clone();
        unblock(move || db.collection::<T>(name).count_all()).await
    }

    /// Async sibling of [`crate::Collection::find_unique`].
    ///
    /// # Errors
    ///
    /// As [`crate::Collection::find_unique`].
    pub async fn find_unique<K>(&self, index_name: &str, key: K) -> Result<Option<T>>
    where
        K: Into<obj_core::codec::Dynamic> + Send + 'static,
    {
        let db = Arc::clone(&self.db);
        let name = self.name.clone();
        let index_name = index_name.to_owned();
        unblock(move || db.collection::<T>(name).find_unique(&index_name, key)).await
    }
}