grit-lib 0.5.25

Core library for the grit Git implementation
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

//! Workspace snapshot capture/restore for undo logs.

use crate::error::Result;
use crate::porcelain::workspace_snapshot::{
    capture_workspace_snapshot, restore_workspace_snapshot, WorkspaceCaptureOptions,
    WorkspaceRestoreOptions, WorkspaceSnapshot,
};
use crate::progress::{Cancel, ProgressSink};
use crate::repo::Repository;

/// Capture and restore full workspace state (index stages, worktree, refs, operation sentinels).
#[derive(Debug, Copy, Clone)]
pub struct RepositoryWorkspaceSnapshot<'repo> {
    repo: &'repo Repository,
}

impl<'repo> RepositoryWorkspaceSnapshot<'repo> {
    pub(crate) fn new(repo: &'repo Repository) -> Self {
        Self { repo }
    }

    /// Borrow the underlying repository.
    #[must_use]
    pub fn repository(&self) -> &'repo Repository {
        self.repo
    }

    /// Capture the current workspace without mutating the repository.
    ///
    /// # Errors
    ///
    /// Propagates errors from [`capture_workspace_snapshot`].
    pub fn capture(&self, options: &WorkspaceCaptureOptions) -> Result<WorkspaceSnapshot> {
        capture_workspace_snapshot(self.repo, options)
    }

    /// Restore a snapshot produced by [`Self::capture`].
    ///
    /// # Errors
    ///
    /// Propagates errors from [`restore_workspace_snapshot`].
    pub fn restore(
        &self,
        snapshot: &WorkspaceSnapshot,
        options: &WorkspaceRestoreOptions,
        progress: &mut dyn ProgressSink,
        cancel: &dyn Cancel,
    ) -> Result<()> {
        restore_workspace_snapshot(self.repo, snapshot, options, progress, cancel)
    }
}