vsdb 13.2.0

A std-collection-like database
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

//!
//! Ergonomic branch handles for [`VerMap`].
//!
//! [`Branch`] provides read-only access to a specific branch, while
//! [`BranchMut`] adds write access.  Both eliminate the need to pass
//! a [`BranchId`] on every operation.
//!
//! ```ignore
//! let mut m: VerMap<u32, String> = VerMap::new();
//! let mut main = m.main_mut();
//! main.insert(&1, &"hello".into())?;
//! main.commit()?;
//! ```

use crate::common::ende::{KeyEnDeOrdered, ValueEnDe};
use crate::common::error::Result;
use crate::versioned::diff::DiffEntry;
use crate::versioned::map::VerMap;
use crate::versioned::{BranchId, CommitId};
use std::ops::Bound;
/// Read-only handle bound to a specific branch.
///
/// Obtained via [`VerMap::branch`] or [`VerMap::main`].
#[derive(Debug)]
pub struct Branch<'a, K, V> {
    pub(super) map: &'a VerMap<K, V>,
    pub(super) id: BranchId,
}

impl<'a, K, V> Branch<'a, K, V>
where
    K: KeyEnDeOrdered,
    V: ValueEnDe,
{
    /// Returns the branch ID.
    pub fn id(&self) -> BranchId {
        self.id
    }

    /// Returns the branch name, if it exists.
    pub fn name(&self) -> Option<String> {
        self.map.branch_name(self.id)
    }

    /// Reads a value from the working state.
    pub fn get(&self, key: &K) -> Result<Option<V>> {
        self.map.get(self.id, key)
    }

    /// Checks if `key` exists in the working state.
    pub fn contains_key(&self, key: &K) -> Result<bool> {
        self.map.contains_key(self.id, key)
    }

    /// Iterates all entries in ascending key order.
    pub fn iter(&self) -> Result<impl Iterator<Item = (K, V)> + '_> {
        self.map.iter(self.id)
    }

    /// Iterates entries within `bounds` in ascending key order.
    pub fn range(
        &self,
        lo: Bound<&K>,
        hi: Bound<&K>,
    ) -> Result<impl Iterator<Item = (K, V)> + '_> {
        self.map.range(self.id, lo, hi)
    }

    /// Returns `true` if the branch has uncommitted changes.
    pub fn has_uncommitted(&self) -> Result<bool> {
        self.map.has_uncommitted(self.id)
    }

    /// Returns the head commit on this branch, if any.
    pub fn head_commit(&self) -> Result<Option<crate::versioned::Commit>> {
        self.map.head_commit(self.id)
    }

    /// Walks the first-parent commit history from head to root.
    pub fn log(&self) -> Result<Vec<crate::versioned::Commit>> {
        self.map.log(self.id)
    }

    /// Computes the diff of uncommitted changes relative to HEAD.
    pub fn diff_uncommitted(&self) -> Result<Vec<DiffEntry>> {
        self.map.diff_uncommitted(self.id)
    }
}

/// Mutable handle bound to a specific branch.
///
/// Obtained via [`VerMap::branch_mut`] or [`VerMap::main_mut`].
/// Provides all [`Branch`] read methods plus write operations.
#[derive(Debug)]
pub struct BranchMut<'a, K, V> {
    pub(super) map: &'a mut VerMap<K, V>,
    pub(super) id: BranchId,
}

impl<'a, K, V> BranchMut<'a, K, V>
where
    K: KeyEnDeOrdered,
    V: ValueEnDe,
{
    // ---- Read methods (delegate to immutable view) ----

    /// Returns the branch ID.
    pub fn id(&self) -> BranchId {
        self.id
    }

    /// Returns the branch name, if it exists.
    pub fn name(&self) -> Option<String> {
        self.map.branch_name(self.id)
    }

    /// Reads a value from the working state.
    pub fn get(&self, key: &K) -> Result<Option<V>> {
        self.map.get(self.id, key)
    }

    /// Checks if `key` exists in the working state.
    pub fn contains_key(&self, key: &K) -> Result<bool> {
        self.map.contains_key(self.id, key)
    }

    /// Iterates all entries in ascending key order.
    pub fn iter(&self) -> Result<impl Iterator<Item = (K, V)> + '_> {
        self.map.iter(self.id)
    }

    /// Iterates entries within `bounds` in ascending key order.
    pub fn range(
        &self,
        lo: Bound<&K>,
        hi: Bound<&K>,
    ) -> Result<impl Iterator<Item = (K, V)> + '_> {
        self.map.range(self.id, lo, hi)
    }

    /// Returns `true` if the branch has uncommitted changes.
    pub fn has_uncommitted(&self) -> Result<bool> {
        self.map.has_uncommitted(self.id)
    }

    // ---- Write methods ----

    /// Inserts a key-value pair into the working state.
    pub fn insert(&mut self, key: &K, value: &V) -> Result<()> {
        self.map.insert(self.id, key, value)
    }

    /// Removes a key from the working state.
    pub fn remove(&mut self, key: &K) -> Result<()> {
        self.map.remove(self.id, key)
    }

    /// Commits the current working state, returning the commit ID.
    pub fn commit(&mut self) -> Result<CommitId> {
        self.map.commit(self.id)
    }

    /// Discards uncommitted changes, resetting to HEAD.
    pub fn discard(&mut self) -> Result<()> {
        self.map.discard(self.id)
    }

    /// Rolls back to a previous commit.
    pub fn rollback_to(&mut self, target: CommitId) -> Result<()> {
        self.map.rollback_to(self.id, target)
    }
}