vcs-modify-guard 0.1.0

A library for checking whether it is safe to modify files in a VCS worktree.
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

use std::{error::Error, io, path::PathBuf};

use snafu::Snafu;

/// Errors returned by `vcs-modify-guard` operations.
#[derive(Debug, Snafu)]
#[non_exhaustive]
#[snafu(visibility(pub(crate)))]
pub enum ModifyGuardError {
    /// The specified path does not refer to a repository supported by the
    /// enabled backends.
    #[snafu(display("not a VCS repository: {}", path.display()))]
    NotARepository {
        /// The path that was rejected.
        path: PathBuf,
    },
    /// The specified path refers to a repository without a worktree, such as a
    /// Git bare repository.
    #[snafu(display("repository has no worktree: {}", path.display()))]
    RepositoryWithoutWorktree {
        /// The path that was rejected.
        path: PathBuf,
    },
    /// The specified path could not be accessed.
    #[snafu(display("path is inaccessible: {}", path.display()))]
    InaccessiblePath {
        /// The path that was rejected.
        path: PathBuf,
        /// The underlying I/O error.
        source: io::Error,
    },
    /// The specified path was not found.
    #[snafu(display("path not found: {}", path.display()))]
    PathNotFound {
        /// The path that was rejected.
        path: PathBuf,
    },
    /// The specified path could not be resolved to a canonical path.
    #[snafu(display(
        "path could not be resolved to a canonical path: {}",
        path.display()
    ))]
    CanonicalizePath {
        /// The path that was rejected.
        path: PathBuf,
        /// The underlying I/O error.
        source: io::Error,
    },
    /// The specified path is not a directory.
    #[snafu(display("path is not a directory: {}", path.display()))]
    PathNotADirectory {
        /// The path that was rejected.
        path: PathBuf,
    },
    /// The specified path does not resolve to a file.
    #[snafu(display("path does not resolve to a file: {}", path.display()))]
    PathNotAFile {
        /// The path that was rejected.
        path: PathBuf,
    },
    /// The specified path does not resolve to a valid path within the
    /// repository worktree.
    #[snafu(display(
        "path does not resolve to a valid path within the repository worktree: {}",
        path.display()
    ))]
    ResolveAsWorktreeRelativePath {
        /// The path that was rejected.
        path: PathBuf,
    },
    /// The specified path does not resolve to a single file within the repository worktree.
    #[snafu(display(
        "path does not resolve to a single file within the repository worktree: {}",
        wt_path.display()
    ))]
    AmbiguousFilePath {
        /// The path that was rejected.
        wt_path: PathBuf,
    },
    /// VCS backend error.
    #[snafu(transparent)]
    Backend {
        /// The underlying error returned by the VCS backend.
        source: Box<dyn Error + Send + Sync + 'static>,
    },
}

// assert that ModifyGuardError is Send + Sync
const _: () = {
    const fn assert_send_sync<T: Send + Sync>() {}
    assert_send_sync::<ModifyGuardError>();
};